DOC: fix documentation for copyright and credits#5706
Merged
Conversation
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.
Contributor
Author
|
I expect this fix does not need an issue or a news item. |
Mariatta
approved these changes
Feb 17, 2018
Contributor
|
Thanks @gerritholl for the PR, and @Mariatta for merging it 🌮🎉.. I'm working now to backport this PR to: 2.7, 3.6, 3.7. |
Member
|
Thanks! |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Feb 17, 2018
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 <gerrit.holl@gmail.com>
|
GH-5716 is a backport of this pull request to the 3.7 branch. |
|
GH-5717 is a backport of this pull request to the 2.7 branch. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Feb 17, 2018
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 <gerrit.holl@gmail.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Feb 17, 2018
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 <gerrit.holl@gmail.com>
|
GH-5718 is a backport of this pull request to the 3.6 branch. |
miss-islington
added a commit
that referenced
this pull request
Feb 17, 2018
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 <gerrit.holl@gmail.com>
miss-islington
added a commit
that referenced
this pull request
Feb 17, 2018
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 <gerrit.holl@gmail.com>
miss-islington
added a commit
that referenced
this pull request
Feb 17, 2018
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 <gerrit.holl@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adapt documentation for
copyrightandcreditsto reality. Previously, the documentation implied that all each ofcopyright,credits, andlicense, would print a message to call the object in order to see the full text. In reality, onlylicenseexhibits thisbehaviour, and
copyrightandcreditprint their full text either when printed, displayed, or called.