Skip to content

Commit fd9d1c9

Browse files
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 243d6d7) Co-authored-by: Gerrit Holl <[email protected]>
1 parent 836b642 commit fd9d1c9

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

Doc/library/constants.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,13 @@ should not be used in programs.
7373
specified exit code.
7474

7575
.. data:: copyright
76-
license
7776
credits
7877

79-
Objects that when printed, print a message like "Type license() to see the
80-
full license text", and when called, display the corresponding text in a
78+
Objects that when printed or called, print the text of copyright or
79+
credits, respectively.
80+
81+
.. data:: license
82+
83+
Object that when printed, prints the message "Type license() to see the
84+
full license text", and when called, displays the full license text in a
8185
pager-like fashion (one screen at a time).

0 commit comments

Comments
 (0)