Add tests to help ensure the generic options are documented #1527
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
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.
Closes #1508
This PR refactors code that was recently added to build the plotting options Sphinx directive, and re-uses it to implement tests that help ensure the converter options (
HoloViewsConverter._options_groups) are documented in a docstring, and that there are no docstring parameters not defined in one of the options groups.Additionally, it adds
xandyto the kind options.xwas always there (i.e. the signature of all the plotting methods was patched withxincluded) while not all plotting methods acceptxlikehist().