Skip to content

Commit f6c8dcf

Browse files
Update config.py
1 parent 9138c2c commit f6c8dcf

File tree

1 file changed

+0
-90
lines changed

1 file changed

+0
-90
lines changed

pandas/_config/config.py

-90
Original file line numberDiff line numberDiff line change
@@ -282,96 +282,6 @@ def set_option(*args) -> None:
282282

283283

284284
# def set_option(*args, **kwargs) -> None:
285-
# """
286-
# Set the value of the specified option or options.
287-
288-
# This function allows fine-grained control over the behavior and display settings
289-
# of pandas. Options affect various functionalities such as output formatting,
290-
# display limits, and operational behavior. Settings can be modified at runtime
291-
# without requiring changes to global configurations or environment variables.
292-
293-
# Options can be provided in any one of the following forms:
294-
295-
# 1. **Dictionary as a single positional argument:**
296-
# Pass a dictionary where each key is an option pattern and its corresponding
297-
# value is the new option value.
298-
299-
# Example:
300-
301-
# >>> pd.set_option({"display.max_columns": 4, "display.width": 80})
302-
303-
# 2. **Keyword arguments or dictionary unpacking:**
304-
# Pass options as keyword arguments, where each keyword is the option name and
305-
# its corresponding value is the new option value. This also supports
306-
# dictionary unpacking using the double asterisk syntax.
307-
308-
# Example:
309-
310-
# >>> pd.set_option(display_max_columns=4, display_width=80)
311-
# >>> options = {"display.max_columns": 4, "display.width": 80}
312-
# >>> pd.set_option(**options)
313-
314-
# 3. **Traditional paired positional arguments:**
315-
# Provide an even number of positional arguments that are interpreted as
316-
# (pattern, value) pairs.
317-
318-
# Example:
319-
320-
# >>> pd.set_option("display.max_columns", 4, "display.width", 80)
321-
322-
# Parameters
323-
# ----------
324-
# *args : str | object | dict
325-
# Depending on the form:
326-
# - A single dictionary of options.
327-
# - Or an even number of arguments representing (pattern, value) pairs.
328-
# **kwargs : object
329-
# When provided, keyword arguments are treated as options where the keyword
330-
# is the option name and the value is the new option value. This includes
331-
# dictionary unpacking using the ** syntax.
332-
333-
# Returns
334-
# -------
335-
# None
336-
# This function does not return a value.
337-
338-
# Raises
339-
# ------
340-
# ValueError
341-
# If an odd number of non-keyword arguments is provided.
342-
# TypeError
343-
# If the passed arguments do not match the expected types.
344-
# OptionError
345-
# If a specified option does not exist.
346-
347-
# See Also
348-
# --------
349-
# get_option : Retrieve the value of the specified option.
350-
# reset_option : Reset one or more options to their default value.
351-
# describe_option : Print the description for one or more registered options.
352-
# option_context : Context manager to temporarily set options in a statement.
353-
354-
# Notes
355-
# -----
356-
# For a complete list of available options, please refer to the
357-
# :ref:`User Guide <options.available>` or use ``pandas.describe_option()``.
358-
359-
# Examples
360-
# --------
361-
# Using a dictionary:
362-
363-
# >>> pd.set_option({"display.max_columns": 4, "display.width": 80})
364-
365-
# Using keyword arguments or dictionary unpacking:
366-
367-
# >>> pd.set_option(display_max_columns=4, display_width=80)
368-
# >>> options = {"display.max_columns": 4, "display.width": 80}
369-
# >>> pd.set_option(**options)
370-
371-
# Using paired positional arguments:
372-
373-
# >>> pd.set_option("display.max_columns", 4, "display.width", 80)
374-
# """
375285
# # Handle dictionary passed directly
376286
# if len(args) == 1 and isinstance(args[0], dict):
377287
# options = args[0]

0 commit comments

Comments
 (0)