Skip to content

Fixed code issue from compat with new numpydoc #26188

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
merged 5 commits into from
Apr 23, 2019

Conversation

WillAyd
Copy link
Member

@WillAyd WillAyd commented Apr 22, 2019

  • closes Doc Check Failures #26187
  • tests added / passed
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

@WillAyd WillAyd added Docs CI Continuous Integration Dependencies Required and optional dependencies labels Apr 22, 2019
@@ -473,8 +473,7 @@ def parameter_desc(self, param):
@property
def see_also(self):
return collections.OrderedDict((name, ''.join(desc))
for name, desc, _
in self.doc['See Also'])
for name, desc in self.doc['See Also'])
Copy link
Contributor

Choose a reason for hiding this comment

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

prob want to put a numpydoc>=0.9.0 in environment.yml

alt you might be able to

for name, desc, * in self.doc[....]

@codecov
Copy link

codecov bot commented Apr 22, 2019

Codecov Report

Merging #26188 into master will decrease coverage by 51.27%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master   #26188       +/-   ##
===========================================
- Coverage   91.98%   40.71%   -51.28%     
===========================================
  Files         175      175               
  Lines       52371    52371               
===========================================
- Hits        48175    21321    -26854     
- Misses       4196    31050    +26854
Flag Coverage Δ
#multiple ?
#single 40.71% <ø> (-0.15%) ⬇️
Impacted Files Coverage Δ
pandas/io/formats/latex.py 0% <0%> (-100%) ⬇️
pandas/io/sas/sas_constants.py 0% <0%> (-100%) ⬇️
pandas/core/groupby/categorical.py 0% <0%> (-100%) ⬇️
pandas/tseries/plotting.py 0% <0%> (-100%) ⬇️
pandas/tseries/converter.py 0% <0%> (-100%) ⬇️
pandas/io/formats/html.py 0% <0%> (-99.37%) ⬇️
pandas/io/sas/sas7bdat.py 0% <0%> (-91.16%) ⬇️
pandas/io/sas/sas_xport.py 0% <0%> (-90.1%) ⬇️
pandas/core/tools/numeric.py 10.44% <0%> (-89.56%) ⬇️
pandas/io/s3.py 0% <0%> (-89.48%) ⬇️
... and 130 more

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 fecee8f...5574b4d. Read the comment docs.

@codecov
Copy link

codecov bot commented Apr 22, 2019

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #26188      +/-   ##
==========================================
- Coverage   91.98%   91.98%   -0.01%     
==========================================
  Files         175      175              
  Lines       52371    52371              
==========================================
- Hits        48175    48172       -3     
- Misses       4196     4199       +3
Flag Coverage Δ
#multiple 90.53% <ø> (ø) ⬆️
#single 40.7% <ø> (-0.16%) ⬇️
Impacted Files Coverage Δ
pandas/io/gbq.py 78.94% <0%> (-10.53%) ⬇️
pandas/core/frame.py 96.9% <0%> (-0.12%) ⬇️
pandas/util/testing.py 90.71% <0%> (+0.1%) ⬆️

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 fecee8f...3a7e4e4. Read the comment docs.

@pep8speaks
Copy link

pep8speaks commented Apr 23, 2019

Hello @WillAyd! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2019-04-23 02:22:06 UTC

for name, desc, _
in self.doc['See Also'])
result = collections.OrderedDict()
for funcs, desc in self.doc['See Also']:
Copy link
Contributor

Choose a reason for hiding this comment

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

could write this as a list comprehension but not a big deal

@rgommers
Copy link
Contributor

Hmm, this seemed to rely on some numpydoc implementation details, we at least don't consider numpydoc.docscrape.NumpyDocString public. PR LGTM.

@jreback jreback added this to the 0.25.0 milestone Apr 23, 2019
@jreback jreback merged commit fdda543 into pandas-dev:master Apr 23, 2019
@jreback
Copy link
Contributor

jreback commented Apr 23, 2019

thanks @WillAyd

anmyachev pushed a commit to anmyachev/pandas that referenced this pull request Apr 24, 2019
anmyachev added a commit to anmyachev/pandas that referenced this pull request Apr 24, 2019
TST: Check pytables<3.5.1 when skipping (pandas-dev#25773)

* TST: Check pytables<3.5.1 when skipping

3.5.1 was made available on conda, causing
'xfail_non_writeable' tests to fail.

* TST: Skip geopandas downstream test

xref pandas-devgh-25778

added 'except NULL' for get_c_string_buf_and_size in util.pxd(bug without)

fixed lint error

Fixed code issue from compat with new numpydoc (pandas-dev#26188)

fixed docstring
anmyachev added a commit to anmyachev/pandas that referenced this pull request Apr 25, 2019
TST: Check pytables<3.5.1 when skipping (pandas-dev#25773)

* TST: Check pytables<3.5.1 when skipping

3.5.1 was made available on conda, causing
'xfail_non_writeable' tests to fail.

* TST: Skip geopandas downstream test

xref pandas-devgh-25778

added 'except NULL' for get_c_string_buf_and_size in util.pxd(bug without)

fixed lint error

Fixed code issue from compat with new numpydoc (pandas-dev#26188)

fixed docstring
anmyachev added a commit to anmyachev/pandas that referenced this pull request Apr 25, 2019
TST: Check pytables<3.5.1 when skipping (pandas-dev#25773)

* TST: Check pytables<3.5.1 when skipping

3.5.1 was made available on conda, causing
'xfail_non_writeable' tests to fail.

* TST: Skip geopandas downstream test

xref pandas-devgh-25778

added 'except NULL' for get_c_string_buf_and_size in util.pxd(bug without)

fixed lint error

Fixed code issue from compat with new numpydoc (pandas-dev#26188)

fixed docstring
anmyachev added a commit to anmyachev/pandas that referenced this pull request Apr 25, 2019
TST: Check pytables<3.5.1 when skipping (pandas-dev#25773)

* TST: Check pytables<3.5.1 when skipping

3.5.1 was made available on conda, causing
'xfail_non_writeable' tests to fail.

* TST: Skip geopandas downstream test

xref pandas-devgh-25778

added 'except NULL' for get_c_string_buf_and_size in util.pxd(bug without)

fixed lint error

Fixed code issue from compat with new numpydoc (pandas-dev#26188)

fixed docstring
@WillAyd WillAyd deleted the numpydoc-compat branch January 16, 2020 00:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Dependencies Required and optional dependencies Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Doc Check Failures
5 participants