Skip to main content
`Ctrl`+`K`

# pandas.describe_option

pandas.describe_option(pat='', _print_desc=True)

  Print the description for one or more registered options.

  Call with no arguments to get a listing for all registered options.

  Parameters:
    pat str, default “”

      String or string regexp pattern. Empty string will return all options. For regexp strings, all matching keys will have their description displayed.

    _print_desc bool, default True

      If True (default) the description(s) will be printed to stdout. Otherwise, the description(s) will be returned as a string (for testing).

  Returns:
    None

      If `_print_desc=True`.

    str

      If the description(s) as a string if `_print_desc=False`.

  See also

  `get_option`

    Retrieve the value of the specified option.

  `set_option`

    Set the value of the specified option or options.

  `reset_option`

    Reset one or more options to their default value.

  Notes

  For all available options, please view the User Guide.

  Examples

      >>> pd.describe_option("display.max_columns")
      display.max_columns : int
          If max_cols is exceeded, switch to truncate view...