Mark self.* expressions in docstrings as literal #15891
Merged
Conversation
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
anntzer
reviewed
Dec 9, 2019
| @@ -7,7 +7,7 @@ | ||
| the button. This class gives click- and release-events and also draws | ||
| a line or a box from the click-point to the actual mouseposition | ||
| (within the same axes) until the button is released. Within the | ||
| method 'self.ignore()' it is checked whether the button from eventpress | ||
| method ``self.ignore()`` it is checked whether the button from eventpress |
There was a problem hiding this comment.
This should really be within :meth:`.ignore`, no? (not that it really matters here as this is not an API doc, but still...).
There was a problem hiding this comment.
Well, possibly. But there are multiple .ignore methods and I was too lazy to find out which one to link. IMHO it's good enough for now.
NelleV
approved these changes
Dec 9, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Summary