8.2 Help Notes

The add_note method of the ConfigParser may be used to append preformatted text to the help text.

add_note( note): note is a positional string argument and is the preformatted text to be appended to the end of the generated help text.

The add_note method of instances of an option object returned by the add_option method (same prototype) performs the same action but also causes the preformatted text to be printed if an error occurs when option is retrieved. Also the preformatted text is inserted as a comment above option settings added to configuration files.