[Python-checkins] DOC: fix documentation for copyright and credits (GH-5706)

Miss Islington (bot) webhook-mailer at python.org
Fri Feb 16 23:09:23 EST 2018


https://github.com/python/cpython/commit/025544a855ef3f3f7f21c1b6e4f19b47dcd30933
commit: 025544a855ef3f3f7f21c1b6e4f19b47dcd30933
branch: 3.7
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: GitHub <noreply at github.com>
date: 2018-02-16T20:09:20-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.
(cherry picked from commit 243d6d71265be1996a8326002deae429106a5fba)

Co-authored-by: Gerrit Holl <gerrit.holl at gmail.com>

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