Skip to content

Avoid reprocessing already numpydocced docstrings #135

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Nov 1, 2017
Merged

Avoid reprocessing already numpydocced docstrings #135

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d65e16b
Avoid reprocessing already numpydocced docstrings
jnothman Oct 31, 2017
8a7fa50
Remove debugging print statement
jnothman Oct 31, 2017
795f576
Make sure case when class + method docstrings are combined is not rep…
jnothman Nov 1, 2017
f902cc7
Correct deduplication logic
jnothman Nov 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions numpydoc/numpydoc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,12 @@ def rename_references(app, what, name, obj, options, lines,
reference_offset[0] += len(references)


DEDUPLICATION_TAG = ' !! processed by numpydoc !!'


def mangle_docstrings(app, what, name, obj, options, lines):
if DEDUPLICATION_TAG in lines:
return

cfg = {'use_plots': app.config.numpydoc_use_plots,
'show_class_members': app.config.numpydoc_show_class_members,
Expand Down Expand Up @@ -100,6 +105,8 @@ def mangle_docstrings(app, what, name, obj, options, lines):
# duplicates
rename_references(app, what, name, obj, options, lines)

lines += ['..', DEDUPLICATION_TAG]


def mangle_signature(app, what, name, obj, options, sig, retann):
# Do not try to inspect classes that don't define `__init__`
Expand Down