8000 BUG: Ignore versionadded directive when checking for periods at docstring end by bengineer19 · Pull Request #22423 · pandas-dev/pandas · GitHub
[go: up one dir, main page]
Skip to content

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.

Sign up for GitHub

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
merged 9 commits into from
Aug 23, 2018
Merged

BUG: Ignore versionadded directive when checking for periods at docstring end #22423

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 Aug 19, 2018
b06cdbf
TST: Added test cases for versionadded directive
bengineer19 Aug 19, 2018
25382b9
BUG: Refactor to ignore versionchanged and deprecated directives.
bengineer19 Aug 19, 2018
cd861fe
TST: Add multiple directives to tests
bengineer19 Aug 19, 2018
cb4bcc3
CLN: Add property for parameter descriptions excluding directives
bengineer19 Aug 20, 2018
748b167
TST: Update test cases for ignoring directives to be more concise.
bengineer19 Aug 20, 2018
37da2cc
CLN: Change parameter_desc to strip out directives
bengineer19 Aug 21, 2018
ccfa4d6
CLN: Remove raw_parameter_desc as it currently serves no purpose
bengineer19 Aug 22, 2018
3039d78
TST: Test directive descriptions
bengineer19 Aug 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
8000 Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
BUG: Refactor to ignore versionchanged and deprecated directives.
  • Loading branch information
@bengineer19
bengineer19 committed Aug 19, 2018
commit 25382b9bbabf1e1590cb872bb9ceedd1468e2e1f
17 changes: 10 additions & 7 deletions scripts/validate_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@


PRIVATE_CLASSES = ['NDFrame', 'IndexOpsMixin']
DIRECTIVES = ['.. versionadded', '.. versionchanged', '.. deprecated']
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

afaik, all sphinx directives start with .. so I think it's better to have just the names here.



def _load_obj(obj_name):
Expand Down Expand Up @@ -466,13 +467,15 @@ def validate_one(func_name):
'should start with a '
'capital letter'.format(param))

if '.. versionadded::' in doc.parameter_desc(param):
index = doc.parameter_desc(param).index('.. versionadded::')
# Check for periods at the end of the description before the
# versionadded directive
period_check_index = index - 1
else:
period_check_index = -1
period_check_index = -1
for directive in DIRECTIVES:
if directive in doc.parameter_desc(param):
# Get index of character before start of directive
index = doc.parameter_desc(param).index(directive) - 1
# If this directive is closest to the description, use it.
if index < period_check_index or period_check_index is -1:
period_check_index = index

if doc.parameter_desc(param)[period_check_index] != '.':
Copy link
Member

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 the parameter_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] != '.':

Copy link
Contributor Author

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.

param_errs.append('Parameter "{}" description '
'should finish with "."'.format(param))
Expand Down
0