[Python-checkins] DOC: fix documentation for copyright and credits (GH-5706)
Mariatta
webhook-mailer at python.org
Fri Feb 16 22:49:02 EST 2018
https://github.com/python/cpython/commit/243d6d71265be1996a8326002deae429106a5fba
commit: 243d6d71265be1996a8326002deae429106a5fba
branch: master
author: Gerrit Holl <gerrit.holl at gmail.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2018-02-16T19:48:57-08:00
summary:
DOC: fix documentation for copyright and credits (GH-5706)
Adapt documentation for `copyright` and `credits` to reality. Previously, the documentation implied that all each of `copyright`,
`credits`, and `license`, would print a message to call the object in order to see the full text. In reality, only `license` exhibits this
behaviour, and `copyright` and `credit` print their full text either when printed, displayed, or called.
files:
M Doc/library/constants.rst
diff --git a/Doc/library/constants.rst b/Doc/library/constants.rst
index 469a3eed606f..78f161963698 100644
--- a/Doc/library/constants.rst
+++ b/Doc/library/constants.rst
@@ -86,10 +86,14 @@ should not be used in programs.
specified exit code.
.. data:: copyright
- license
credits
- Objects that when printed, print a message like "Type license() to see the
- full license text", and when called, display the corresponding text in a
+ Objects that when printed or called, print the text of copyright or
+ credits, respectively.
+
+.. data:: license
+
+ Object that when printed, prints the message "Type license() to see the
+ full license text", and when called, displays the full license text in a
pager-like fashion (one screen at a time).
More information about the Python-checkins
mailing list