Patch for NumpyDocString to add more parameter supported classes
#706
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.
At present
docscrape.NumpyDocStringfinally supports all Numpy Document Sections. However, only theParameterssection supports parameters. However pernumpydocmany sections should support parameters e.g. Attributes.This patch:
Adds a constant
PARAM_SECTIONSto note sections which support parameters.Updates
NumpyDocStringto:include a
param_sectionssimilar tosections,normalize the parameter processing done for
NumpyDocString.sections['Parameters']to the supportedparam_sections,exposes configuration options to
NumpyDocString.__init__At present, this will prevent complaints when running
nbdev_preparedue toTypeErrors. For example, consider the simple class:Then:
After applying the patch: