Fix trait_documenter for properties #1246
Merged
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 PR fixes the trait_documenter Sphinx extension so that it no longer fails on regular Python properties. It does this by modifying the
can_document_member
function so that it doesn't recognise generic traits. This makes sense, since a generic trait is deliberately designed to behave like a standard Pythonobject
attribute.Mostly fixes #1238, but independently of this fix, it would be good to fix the trait-documenter to be less fragile, so that if it fails in some other situation in the future then that failure doesn't prevent the Sphinx build from completing.
EDIT: See #1247 for the "make trait-documenter less fragile" fix.