Skip to content

Doc Check Failures #26187

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
WillAyd opened this issue Apr 22, 2019 · 1 comment · Fixed by #26188
Closed

Doc Check Failures #26187

WillAyd opened this issue Apr 22, 2019 · 1 comment · Fixed by #26188
Labels
CI Continuous Integration Dependencies Required and optional dependencies
Milestone

Comments

@WillAyd
Copy link
Member

WillAyd commented Apr 22, 2019

This just started showing up in the CI failures today:

Traceback (most recent call last):
  File "ci/../scripts/validate_docstrings.py", line 991, in <module>
    args.ignore_deprecated))
  File "ci/../scripts/validate_docstrings.py", line 891, in main
    result = validate_all(prefix, ignore_deprecated)
  File "ci/../scripts/validate_docstrings.py", line 845, in validate_all
    doc_info = validate_one(func_name)
  File "ci/../scripts/validate_docstrings.py", line 801, in validate_one
    errs, wrns, examples_errs = get_validation_data(doc)
  File "ci/../scripts/validate_docstrings.py", line 749, in get_validation_data
    if not doc.see_also:
  File "ci/../scripts/validate_docstrings.py", line 477, in see_also
    in self.doc['See Also'])
  File "ci/../scripts/validate_docstrings.py", line 476, in <genexpr>
    for name, desc, _
ValueError: not enough values to unpack (expected 3, got 2)

I think it's an issue with upgrading to numpydoc 0.9 but will look in more detail and confirm

@WillAyd WillAyd added CI Continuous Integration Dependencies Required and optional dependencies labels Apr 22, 2019
@WillAyd
Copy link
Member Author

WillAyd commented Apr 22, 2019

Here's the relevant enhancement on the numpydoc side released in v0.9:

numpy/numpydoc#172

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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants