Commit 243d6d71 authored by Gerrit Holl's avatar Gerrit Holl Committed by Mariatta

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.
parent 6887d86e
...@@ -86,10 +86,14 @@ should not be used in programs. ...@@ -86,10 +86,14 @@ should not be used in programs.
specified exit code. specified exit code.
.. data:: copyright .. data:: copyright
license
credits credits
Objects that when printed, print a message like "Type license() to see the Objects that when printed or called, print the text of copyright or
full license text", and when called, display the corresponding text in a 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). pager-like fashion (one screen at a time).
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment