]> granicus.if.org Git - python/commitdiff
DOC: fix documentation for copyright and credits (GH-5706)
authorGerrit Holl <gerrit.holl@gmail.com>
Sat, 17 Feb 2018 03:48:57 +0000 (03:48 +0000)
committerMariatta <Mariatta@users.noreply.github.com>
Sat, 17 Feb 2018 03:48:57 +0000 (19:48 -0800)
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.

Doc/library/constants.rst

index 469a3eed606ff079eb9a81b2d0b66c5cce037ed4..78f16196369810810ff3dd3fd26103976b57681c 100644 (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).