-
-
Notifications
You must be signed in to change notification settings - Fork 18.7k
BUG: Ignore versionadded directive when checking for periods at docstring end #22423
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
datapythonista
merged 9 commits into
pandas-dev:master
from
bengineer19:validate_docstrings_versionadded
Aug 23, 2018
Merged
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
ac1ca24
BUG: Ignore versionadded directive when checking for periods at docst…
bengineer19 b06cdbf
TST: Added test cases for versionadded directive
bengineer19 25382b9
BUG: Refactor to ignore versionchanged and deprecated directives.
bengineer19 cd861fe
TST: Add multiple directives to tests
bengineer19 cb4bcc3
CLN: Add property for parameter descriptions excluding directives
bengineer19 748b167
TST: Update test cases for ignoring directives to be more concise.
bengineer19 37da2cc
CLN: Change parameter_desc to strip out directives
bengineer19 ccfa4d6
CLN: Remove raw_parameter_desc as it currently serves no purpose
bengineer19 3039d78
TST: Test directive descriptions
bengineer19 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next
Next commit
BUG: Ignore versionadded directive when checking for periods at docst…
…ring end
- Loading branch information
commit ac1ca248406d227bcc9e729903e0a98414be2dcc
There are no files selected for viewing
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think about creating a new property in the class
Docstring
that returns theparameter_desc
but without directives?I think the code will be much more readable if we have this logic there, and in this part of the code where all validations happen we simply have something like
if doc.parameter_desc_without_directives(param)[-1] != '.':
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I agree that would be more useful and readable; I'll make a property.