Skip to content
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

Fix bug in the handling of types inside consolidated fields #766

Merged
merged 3 commits into from
Mar 25, 2024

Conversation

tristanlatr
Copy link
Contributor

Fixes #765

Copy link

codecov bot commented Mar 24, 2024

Codecov Report

Attention: Patch coverage is 86.66667% with 2 lines in your changes are missing coverage. Please review.

Project coverage is 92.68%. Comparing base (9becf85) to head (ff6b03b).

Files Patch % Lines
pydoctor/epydoc/markup/_types.py 86.66% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master     #766      +/-   ##
==========================================
- Coverage   92.69%   92.68%   -0.02%     
==========================================
  Files          47       47              
  Lines        8285     8279       -6     
  Branches     1826     1828       +2     
==========================================
- Hits         7680     7673       -7     
  Misses        347      347              
- Partials      258      259       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This comment has been minimized.

Copy link

Diff from pydoctor_primer, showing the effect of this PR on open source code:

numpy (https://github.com/numpy/numpy)
- /projects/numpy/numpy/lib/_nanfunctions_impl.py:630: bad docstring: NotImplementedError: <class 'pydoctor.epydoc.markup._types.ParsedTypeDocstring._tokenize_node_type_spec.<locals>.Tokenizer'> visiting unknown node type: versionmodified
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:662: bad docstring: Unexpected element in type specification field: element 'paragraph'. This value should only contain text or inline markup.
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:670: Cannot find link target for "~numpy.ufunc.reduce" (you can link to external docs with --intersphinx)
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:674: Cannot find link target for "~numpy.ufunc.reduce" (you can link to external docs with --intersphinx)
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:687: Cannot find link target for "numpy.sum"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:690: Cannot find link target for "isnan"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:692: Cannot find link target for "isfinite"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:637: Cannot find link target for "array_like"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:640: Cannot find link target for "tuple"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:640: Cannot find link target for "int"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:649: Cannot find link target for "data-type"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:657: Cannot find link target for "ndarray"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:661: Cannot find link target for "bool"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:678: Cannot find link target for "out"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:680: Cannot find link target for "axis"
+ /projects/numpy/numpy/lib/_nanfunctions_impl.py:682: Cannot find link target for "ndarray." (you can link to external docs with --intersphinx)

@tristanlatr tristanlatr merged commit f835fb4 into master Mar 25, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Failure to process classifiers as part of consolidation fields in a reStructuredText docstring
1 participant