`astropy.config.configuration:ConfigNamespace.help`

source: /astropy/config/configuration.py :124

Signature

def help ( self , name = None )

Summary

Print info about configuration items.

Parameters

name : `str`, optional: Name of the configuration item to be described. If no name is provided then info about all the configuration items will be printed.

Examples

from astropy import conf
conf.help("unicode_output")

✓

ConfigItem: unicode_output
  cfgtype='boolean'
  defaultvalue=False
  description='When True, use Unicode characters when outputting values, and displaying widgets at the console.'
  module=astropy
  value=False

Aliases

astropy.config.ConfigNamespace.help