diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2018-02-17 04:16:52 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-02-17 04:16:52 (GMT) |
| commit | f2d2e6169eb31e1a223d29d5de07e80939939106 (patch) | |
| tree | f54ebcc26c32d66ac663d894ffd3ba4b13be5bf7 | |
| parent | 76591bc03a26e8fde143c25cb88a98f1c96f8bc2 (diff) | |
| download | cpython-f2d2e6169eb31e1a223d29d5de07e80939939106.zip cpython-f2d2e6169eb31e1a223d29d5de07e80939939106.tar.gz cpython-f2d2e6169eb31e1a223d29d5de07e80939939106.tar.bz2 | |
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@gmail.com>
| -rw-r--r-- | Doc/library/constants.rst | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/Doc/library/constants.rst b/Doc/library/constants.rst index 469a3ee..78f1619 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). |