search

twisted / pydoctor

This is pydoctor, an API documentation generator that works by static analysis.
https://pydoctor.readthedocs.io/
Other
179 stars 47 forks source link

Trigger a warning when several docstrings are detected #802

Closed tristanlatr closed 3 days ago

tristanlatr commented 2 weeks ago

Related to #800

github-actions[bot] commented 2 weeks ago

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

astroid (https://github.com/pylint-dev/astroid)
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:262: Existing docstring at line 259 is overriden
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:1908: Existing docstring at line 1852 is overriden

pycma (https://github.com/CMA-ES/pycma)
+ /projects/pycma/cma/sampler.py:249: Existing docstring at line 244 is overriden

numpy (https://github.com/numpy/numpy)
+ /projects/numpy/numpy/distutils/ccompiler_opt.py:1038: Existing docstring at line 949 is overriden
codecov[bot] commented 2 weeks ago

Codecov Report

Attention: Patch coverage is 90.90909% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.59%. Comparing base (dca9625) to head (537fb05).

Files Patch % Lines
pydoctor/model.py 90.00% 0 Missing and 1 partial :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #802 +/- ## ========================================== - Coverage 92.62% 92.59% -0.03% ========================================== Files 47 47 Lines 8393 8402 +9 Branches 1850 1853 +3 ========================================== + Hits 7774 7780 +6 - Misses 356 357 +1 - Partials 263 265 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

github-actions[bot] commented 2 weeks ago

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

pycma (https://github.com/CMA-ES/pycma)
+ /projects/pycma/cma/sampler.py:249: Existing docstring at line 244 is overriden

astroid (https://github.com/pylint-dev/astroid)
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:262: Existing docstring at line 259 is overriden
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:1908: Existing docstring at line 1852 is overriden

numpy (https://github.com/numpy/numpy)
+ /projects/numpy/numpy/distutils/ccompiler_opt.py:1038: Existing docstring at line 949 is overriden
github-actions[bot] commented 2 weeks ago

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

astroid (https://github.com/pylint-dev/astroid)
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:262: Existing docstring at line 259 is overriden
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:1908: Existing docstring at line 1852 is overriden

pycma (https://github.com/CMA-ES/pycma)
+ /projects/pycma/cma/sampler.py:249: Existing docstring at line 244 is overriden

numpy (https://github.com/numpy/numpy)
+ /projects/numpy/numpy/distutils/ccompiler_opt.py:1038: Existing docstring at line 949 is overriden
tristanlatr commented 1 week ago

I believe this PR is clean enough.

github-actions[bot] commented 1 week ago

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

pycma (https://github.com/CMA-ES/pycma)
+ /projects/pycma/cma/sampler.py:249: Existing docstring at line 244 is overriden

astroid (https://github.com/pylint-dev/astroid)
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:262: Existing docstring at line 259 is overriden
+ /projects/astroid/astroid/nodes/scoped_nodes/scoped_nodes.py:1908: Existing docstring at line 1852 is overriden

numpy (https://github.com/numpy/numpy)
+ /projects/numpy/numpy/distutils/ccompiler_opt.py:1038: Existing docstring at line 949 is overriden
tristanlatr commented 3 days ago

Merging this