This repository has been archived by the owner on May 25, 2022. It is now read-only.
Add autodoc attrgetter workaround for classes #130
Merged
Conversation
This file contains 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
…ed here: astropy#116 (comment) In principle other fixes to autodoc could be collected here as well but for now this is the only one.
embray
added a commit
that referenced
this pull request
Jan 26, 2015
Add autodoc attrgetter workaround for classes
embray
added a commit
that referenced
this pull request
Feb 11, 2015
Add autodoc attrgetter workaround for classes
embray
added a commit
to embray/astropy_helpers
that referenced
this pull request
Mar 19, 2015
…his fix was needed. This is more of a followup to astropy#130 to catch some more cases where simply calling getattr() on some objects can result in a non-AttributeError exception.
embray
added a commit
to embray/astropy_helpers
that referenced
this pull request
Mar 28, 2015
…his fix was needed. This is more of a followup to astropy#130 to catch some more cases where simply calling getattr() on some objects can result in a non-AttributeError exception.
astrofrog
pushed a commit
to astropy/sphinx-automodapi
that referenced
this pull request
Jan 27, 2018
…c-attrgetter Add autodoc attrgetter workaround for classes
astrofrog
pushed a commit
to astropy/sphinx-automodapi
that referenced
this pull request
Jan 27, 2018
…c-attrgetter Add autodoc attrgetter workaround for classes
astrofrog
pushed a commit
to astropy/sphinx-astropy
that referenced
this pull request
Jan 29, 2018
…c-attrgetter Add autodoc attrgetter workaround for classes
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This adds a workaround to the issue I mentioned in this comment. For all I know at the moment only the
astropy.modelingpackage is affected by this. This change doesn't seem to have any negative affect for any other docs.In the long-term, one criticism I might add about how the class autodoc works is that it doesn't make a distinction between class attributes and instance attributes (which would include properties). That's something I might like to improve in the future (possibly including an upstream fix to Sphinx in the process).
I think the issue fixed here should probably also be addressed in Sphinx so I'll open an upstream issue.