Trigger a warning when several docstrings are detected #802
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment has been minimized.
This comment has been minimized.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ 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 ☔ View full report in Codecov by Sentry. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
tristanlatr
commented
Jun 21, 2024
| @@ -959,9 +959,7 @@ def _handlePropertyDef(self, | |||
| if tag == 'return': | |||
| if not pdoc.has_body: | |||
| pdoc = field.body() | |||
| # Avoid format_summary() going back to the original | |||
There was a problem hiding this comment.
This is a drive-by cleanup. We don’t generated the summary from the docstring source anymore, so ne don’t need this hack.
tristanlatr
commented
Jun 24, 2024
|
I believe this PR is clean enough. |
|
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
|
|
Merging this |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related to #800