BaseConfig.write_example#

classmethod BaseConfig.write_example(path_, /, comment_=None, **examples)[source]#

Write examples to a config file.

Parameters:

  • path (Path) – Path to the YAML file to write.

  • comment (str, optional) – Comment to add to the top of the example config file, will be formatted to add “#” symbols and split across multiple lines.

  • examples (str) – Fields of the config to write, any missing fields are filled in with their default value (if they have one) or ‘REQUIRED’ / ‘OPTIONAL’.

  • path_ (Path)

  • comment_ (str | None)

Return type:

None