Conversation
This currently fails due to #314
This must have been broken when I moved documentation code into `BaseDescriptor` which handles attribute docstrings but isn't aware of getter/setter functions. The required change was to copy over `__doc__` if it's defined on the function, as was already done for actions. I had to ignore trailing whitespace to get the test passing, I think that's fine.
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
1 participant
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.
The descriptions and titles for functional properties were missing from the Thing Description and the OpenAPI docs. This was due to the getter's docstring being ignored.
I have added a unit test to check for this, and added code to
FunctionalProperty.__init__to copy over the getter's docstring as is done inActionDescriptor.Closes #314