Skip to content

DOC: doc-string validation broken #39688

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

Closed
jreback opened this issue Feb 8, 2021 · 4 comments · Fixed by #45830
Closed

DOC: doc-string validation broken #39688

jreback opened this issue Feb 8, 2021 · 4 comments · Fixed by #45830
Labels
Dependencies Required and optional dependencies Docs
Milestone

Comments

@jreback
Copy link
Contributor

jreback commented Feb 8, 2021

https://github.com/pandas-dev/pandas/pull/39685/checks?check_run_id=1857708224

==================================== ERRORS ====================================
__________ ERROR collecting scripts/tests/test_validate_docstrings.py __________
ImportError while importing test module '/home/runner/work/pandas/pandas/scripts/tests/test_validate_docstrings.py'.
Hint: make sure your test modules/packages have valid Python names.
Traceback:
/usr/share/miniconda/envs/pandas-dev/lib/python3.8/importlib/__init__.py:127: in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
scripts/tests/test_validate_docstrings.py:5: in <module>
    import validate_docstrings
scripts/validate_docstrings.py:50: in <module>
    from numpydoc.validate import validate, Docstring  # isort:skip
E   ImportError: cannot import name 'Docstring' from 'numpydoc.validate' (/usr/share/miniconda/envs/pandas-dev/lib/python3.8/site-packages/numpydoc/validate.py)
=========================== short test summary info ============================
ERROR scripts/tests/test_validate_docstrings.py
!!!!!!!!!!!!!!!!!!!! Interrupted: 1 error during collection !!!!!!!!!!!!!!!!!!!!
=============================== 1 error in 0.54s ===============================
Error: Process completed with exit code 2.

cc @pandas-dev/pandas-core
can we pin numpydoc?

@jreback jreback added Docs Dependencies Required and optional dependencies labels Feb 8, 2021
@jreback jreback added this to the 1.3 milestone Feb 8, 2021
@simonjayhawkins
Copy link
Member

This is also occurring on 1.2.x, e.g. #39693

changing milestone

@simonjayhawkins
Copy link
Member

moved to 1.2.5

@jorisvandenbossche
Copy link
Member

I don't think this needs to be fixed for 1.2.x. It's not an error in our documentation, but a compatibility issue in our validation scripts. I think it's fine to target that for 1.3, and keep it pinned on 1.2.x

@simonjayhawkins
Copy link
Member

sure. removing milestone.

@simonjayhawkins simonjayhawkins removed this from the 1.2.5 milestone Apr 12, 2021
fangchenli added a commit to fangchenli/pandas that referenced this issue May 13, 2021
fangchenli added a commit to fangchenli/pandas that referenced this issue Feb 4, 2022
@jreback jreback added this to the 1.5 milestone Feb 9, 2022
jreback pushed a commit that referenced this issue Feb 11, 2022
phofl pushed a commit to phofl/pandas that referenced this issue Feb 14, 2022
yehoshuadimarsky pushed a commit to yehoshuadimarsky/pandas that referenced this issue Jul 13, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependencies Required and optional dependencies Docs
Projects
None yet
3 participants