feat: wrap Sphinx style long parameter descriptions#201
Merged
weibullguy merged 12 commits intomasterfrom May 15, 2023
Merged
Conversation
* master: chore: add GH release badge (#200)
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.
Adds new argument
--styleto directdocformatterto wrap long parameter descriptions that exceed wrap length. Only "Sphinx" style parameter lists are recognized. NumPy and Google style parameter lists still result in existing behavior of not wrapping the long description (this PR sets the framework to add those styles).Sphinx style parameter lists are in the format:
This PR will be merged following release of v1.7.0.
Closes #58
Closes #68