traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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 243d6d7126)

Co-authored-by: Gerrit Holl <gerrit.holl@gmail.com>
This commit is contained in:
Miss Islington (bot) 2018-02-16 20:09:20 -08:00 committed by GitHub
parent 0f76411059
commit 025544a855
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/constants.rst
View File

@ -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).