Configurator.save¶

Configurator.save(path=None, user=True, comment=None, backup=True, description=False)[source]¶

Save the current settings to a proplotrc file. This writes the default values commented out plus the values that differ from the defaults at the top of the file.

Parameters

path (path-like, default: 'proplotrc') – The file name and/or directory. The default file name is proplotrc and the default directory is the current directory.
user (bool, default: True) – If True then settings that have been changed from the proplot defaults are shown uncommented at the top of the file.
backup (bool, default: True) – Whether to “backup” an existing file by renaming with the suffix .bak or overwrite an existing file.
comment (bool, optional) – Whether to comment out the default settings. If not passed this takes the same value as user.
description (bool, default: False) – Whether to include descriptions of each setting (as seen in the user guide table) as comments.