DOC: Add docstring validations for "See Also" section #23143

getschomp · 2018-10-14T01:55:26Z

closes DOC: Validate description of See Also section in docstrings #23135
tests added / passed
passes git diff upstream/master -u -- "*.py" | flake8 --diff

pep8speaks · 2018-10-14T01:55:28Z

Hello @getschomp! Thanks for submitting the PR.

There are no PEP8 issues in the file scripts/tests/test_validate_docstrings.py !
There are no PEP8 issues in the file scripts/validate_docstrings.py !

codecov · 2018-10-14T02:21:37Z

Codecov Report

Merging #23143 into master will increase coverage by <.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master   #23143      +/-   ##
==========================================
+ Coverage   92.13%   92.13%   +<.01%     
==========================================
  Files         170      170              
  Lines       51073    51077       +4     
==========================================
+ Hits        47056    47060       +4     
  Misses       4017     4017

Flag	Coverage Δ
#multiple	`90.56% <ø> (ø)`	⬆️
#single	`42.28% <ø> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
pandas/io/formats/style.py	`96.69% <0%> (+0.03%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 85dc171...6901171. Read the comment docs.

datapythonista

Thanks for the PR. Looks quite good, just couple of comments.

datapythonista · 2018-10-14T15:25:29Z

scripts/tests/test_validate_docstrings.py

+        """
+        Return the first 5 elements of the Series.
+
+        see Also


I think the lower case is a typo here, right?

datapythonista · 2018-10-14T15:27:08Z

scripts/tests/test_validate_docstrings.py

+        ('BadSeeAlso', 'desc_no_period',
+         ('Missing period at end of description',)),
+        ('BadSeeAlso', 'desc_first_letter_lowercase',
+         ('should be capitalized',)),


Can you test that the element reported is the element with the problem? Meaning that Series.iloc is ok, and in the error message we want to have that this is for Series.tail.

datapythonista · 2018-10-14T15:27:51Z

scripts/validate_docstrings.py

                errs.append('Missing description for '
                            'See Also "{}" reference'.format(rel_name))

+


This blank line is not valid according to PEP-8. If you take a look at the checks, you'll see that travis is red, and if you go to its log, you'll see that this is the reason.

…ation of error

getschomp · 2018-10-14T16:08:17Z

Thanks, @datapythonista, made changes as requested.

datapythonista

lgtm. Thanks for the contribution @getschomp

@WillAyd can you take a look and merge on green if you're happy?

getschomp · 2018-10-26T14:31:07Z

Thanks, @datapythonista, any word @WillAyd?

WillAyd · 2018-10-26T21:23:31Z

Thanks @getschomp nice PR!

…_pr2 * repo_org/master: DOC: Add docstring validations for "See Also" section (pandas-dev#23143) TST: Fix test assertion (pandas-dev#23357) BUG: Handle Period in combine (pandas-dev#23350) REF: SparseArray imports (pandas-dev#23329) CI: Migrate some CircleCI jobs to Azure (pandas-dev#22992) DOC: update the is_month_start/is_month_end docstring (pandas-dev#23051) Partialy fix issue pandas-dev#23334 - isort pandas/core/groupby directory (pandas-dev#23341) TST: Add base test for extensionarray setitem pandas-dev#23300 (pandas-dev#23304) API: Add sparse Acessor (pandas-dev#23183) PERF: speed up CategoricalIndex.get_loc (pandas-dev#23235)

…_series_pr1 * repo_org/master: DOC: Add docstring validations for "See Also" section (pandas-dev#23143)

…ndas * repo_org/master: (23 commits) DOC: Add docstring validations for "See Also" section (pandas-dev#23143) TST: Fix test assertion (pandas-dev#23357) BUG: Handle Period in combine (pandas-dev#23350) REF: SparseArray imports (pandas-dev#23329) CI: Migrate some CircleCI jobs to Azure (pandas-dev#22992) DOC: update the is_month_start/is_month_end docstring (pandas-dev#23051) Partialy fix issue pandas-dev#23334 - isort pandas/core/groupby directory (pandas-dev#23341) TST: Add base test for extensionarray setitem pandas-dev#23300 (pandas-dev#23304) API: Add sparse Acessor (pandas-dev#23183) PERF: speed up CategoricalIndex.get_loc (pandas-dev#23235) fix and test incorrect case in delta_to_nanoseconds (pandas-dev#23302) BUG: Handle Datetimelike data in DataFrame.combine (pandas-dev#23317) TST: re-enable gbq tests (pandas-dev#23303) Switched references of App veyor to azure pipelines in the contributing CI section (pandas-dev#23311) isort imports-io (pandas-dev#23332) DOC: Added a Multi Index example for the Series.sum method (pandas-dev#23279) REF: Make PeriodArray an ExtensionArray (pandas-dev#22862) DOC: Added Examples for Series max (pandas-dev#23298) API/ENH: tz_localize handling of nonexistent times: rename keyword + add shift option (pandas-dev#22644) BUG: Let MultiIndex.set_levels accept any iterable (pandas-dev#23273) (pandas-dev#23291) ...

…xamples * repo_org/master: (83 commits) DOC: Add docstring validations for "See Also" section (pandas-dev#23143) TST: Fix test assertion (pandas-dev#23357) BUG: Handle Period in combine (pandas-dev#23350) REF: SparseArray imports (pandas-dev#23329) CI: Migrate some CircleCI jobs to Azure (pandas-dev#22992) DOC: update the is_month_start/is_month_end docstring (pandas-dev#23051) Partialy fix issue pandas-dev#23334 - isort pandas/core/groupby directory (pandas-dev#23341) TST: Add base test for extensionarray setitem pandas-dev#23300 (pandas-dev#23304) API: Add sparse Acessor (pandas-dev#23183) PERF: speed up CategoricalIndex.get_loc (pandas-dev#23235) fix and test incorrect case in delta_to_nanoseconds (pandas-dev#23302) BUG: Handle Datetimelike data in DataFrame.combine (pandas-dev#23317) TST: re-enable gbq tests (pandas-dev#23303) Switched references of App veyor to azure pipelines in the contributing CI section (pandas-dev#23311) isort imports-io (pandas-dev#23332) DOC: Added a Multi Index example for the Series.sum method (pandas-dev#23279) REF: Make PeriodArray an ExtensionArray (pandas-dev#22862) DOC: Added Examples for Series max (pandas-dev#23298) API/ENH: tz_localize handling of nonexistent times: rename keyword + add shift option (pandas-dev#22644) BUG: Let MultiIndex.set_levels accept any iterable (pandas-dev#23273) (pandas-dev#23291) ...

Allison Browne added 3 commits October 13, 2018 21:45

Add docstring validations for "See Also" section

2755055

Make docstring validation test name more descriptive

09ec596

Fix flake error: line too long

d3313cd

getschomp changed the title ~~Add docstring validations for "See Also" section~~ DOC: Add docstring validations for "See Also" section Oct 14, 2018

Fix for blank/missing doc string

1fabcad

Cleanup error string format

067dad8

thoo mentioned this pull request Oct 14, 2018

DOC: Validate that See Also section items do not contain the pandas. prefix #23145

Merged

datapythonista reviewed Oct 14, 2018

View reviewed changes

datapythonista added Docs CI Continuous Integration labels Oct 14, 2018

CR feedback: make doc string validation tests more specific about loc…

6901171

…ation of error

datapythonista approved these changes Oct 14, 2018

View reviewed changes

WillAyd approved these changes Oct 26, 2018

View reviewed changes

WillAyd merged commit f662c5f into pandas-dev:master Oct 26, 2018

thoo added a commit to thoo/pandas that referenced this pull request Oct 27, 2018

Merge remote-tracking branch 'repo_org/master' into fix_import_format…

7390086

…_series_pr1 * repo_org/master: DOC: Add docstring validations for "See Also" section (pandas-dev#23143)

tm9k1 pushed a commit to tm9k1/pandas that referenced this pull request Nov 19, 2018

DOC: Add docstring validations for "See Also" section (pandas-dev#23143)

341b19c

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Add docstring validations for "See Also" section (pandas-dev#23143)

a4a0b9f

Pingviinituutti pushed a commit to Pingviinituutti/pandas that referenced this pull request Feb 28, 2019

DOC: Add docstring validations for "See Also" section (pandas-dev#23143)

0d0016e

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC: Add docstring validations for "See Also" section #23143

DOC: Add docstring validations for "See Also" section #23143

getschomp commented Oct 14, 2018

pep8speaks commented Oct 14, 2018

codecov bot commented Oct 14, 2018 •

edited

Loading

datapythonista left a comment

datapythonista Oct 14, 2018

datapythonista Oct 14, 2018

datapythonista Oct 14, 2018

getschomp commented Oct 14, 2018

datapythonista left a comment

getschomp commented Oct 26, 2018

WillAyd commented Oct 26, 2018

		errs.append('Missing description for '
		'See Also "{}" reference'.format(rel_name))

DOC: Add docstring validations for "See Also" section #23143

DOC: Add docstring validations for "See Also" section #23143

Conversation

getschomp commented Oct 14, 2018

pep8speaks commented Oct 14, 2018

codecov bot commented Oct 14, 2018 • edited Loading

Codecov Report

datapythonista left a comment

Choose a reason for hiding this comment

datapythonista Oct 14, 2018

Choose a reason for hiding this comment

datapythonista Oct 14, 2018

Choose a reason for hiding this comment

datapythonista Oct 14, 2018

Choose a reason for hiding this comment

getschomp commented Oct 14, 2018

datapythonista left a comment

Choose a reason for hiding this comment

getschomp commented Oct 26, 2018

WillAyd commented Oct 26, 2018

codecov bot commented Oct 14, 2018 •

edited

Loading