Use int instead of numbers.integral in docstring
#237
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.
In general we want to avoid having type-annotation-like types within the docstring. Type annotations are meant to be read by a machine, not by humans, and over time they will clutter the docs.
In this instance,
intis a more common and familiar term thannumbers.Integral, and will help keep the doc more user-friendly. I don't believe there is any loss of accuracy keepingintin the docstring.