diff options
| author | Gerrit Holl <gerrit.holl@gmail.com> | 2018-02-17 03:48:57 (GMT) |
|---|---|---|
| committer | Mariatta <Mariatta@users.noreply.github.com> | 2018-02-17 03:48:57 (GMT) |
| commit | 243d6d71265be1996a8326002deae429106a5fba (patch) | |
| tree | 52339619e8e868ad217644bc5354e0f73fbebfca /Doc/library/constants.rst | |
| parent | 6887d86e9a04b9c5718b08e5d9e1ca3cc1f53721 (diff) | |
| download | cpython-243d6d71265be1996a8326002deae429106a5fba.zip cpython-243d6d71265be1996a8326002deae429106a5fba.tar.gz cpython-243d6d71265be1996a8326002deae429106a5fba.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.
Diffstat (limited to 'Doc/library/constants.rst')
| -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). |