[Tutor] Lengthy copyright notices?
James Hartley
jjhartley at gmail.com
Mon Jul 15 17:25:26 EDT 2019
help(module_name) will place any text in the *first* module-level docstring
into the description section of the help page in Python 3.4.5. Subsequent
docstrings found at module level are ignored.
I have been using this factoid for placement of a copyright & licensing
notice. By placing a rather lengthy copyright & license in the code in a
the second module-level docstring, it is prominent within the code, but not
cluttering up help() output.
Two questions. Is there a more standardized way of including long license
descriptions in code, & is it documented that any other module-level
docstring will be ignored in help() output?
Thanks!
Jim
More information about the Tutor
mailing list