Skip to content

Commit

Permalink
DOC: fix documentation for copyright and credits (GH-5706)
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
miss-islington and gerritholl authored Feb 17, 2018
1 parent 0f76411 commit 025544a
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions Doc/library/constants.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 025544a

Please sign in to comment.