doc_AxesBase_bug #11442
Merged
doc_AxesBase_bug #11442
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
|
What’s the status of this, is it just proof of concept or did you want this reviewed? |
|
I want it reviewed. The bug is the string formating at the end of the docstring, i tclear the whole docstring. The decorator is just a way to get the docstring look at it was intended. |
jklymak
approved these changes
Jun 21, 2018
QuLogic
added a commit
that referenced
this pull request
Jul 5, 2018
…n-v2.2.2-doc Backport PR #11442 on branch v2.2.2-doc
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.
I found out why the axes init function didn't get rendered in the documentation, #10270. The substitution resulted in a blank docstring.
The init docstring is there.
https://10426-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/axes_api.html
edit: the use of the decorator is just a proof of concept. The whole docstring should probably be changed to use
docstring.dedent_interpdwith%(Axes)sinstead and be written as a numpydoc docstring.PR Checklist