Avoid duplicate calls to autodoc-process-docstring #4198
Merged
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
jnothman
force-pushed
the
double-processed
branch
from
7d3b13a to
7ca2b2c
Compare
|
@shimizukawa could you review this please? |
shimizukawa
reviewed
Jan 8, 2018
| @@ -324,7 +324,7 @@ def get_items(self, names): | |||
| # -- Grab the summary | |||
|
|
|||
| documenter.add_content(None) | |||
| doc = list(documenter.process_doc([self.result.data])) | |||
| doc = self.result.data | |||
There was a problem hiding this comment.
I think this fix is correct. Double calling process_doc is caused by leaving a call of process_doc which became unnecessary on #1444.
shimizukawa
added a commit
that referenced
this pull request
Jan 8, 2018
|
I'm glad we agree! |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Subject: Avoid duplicate calls to autodoc-process-docstring
Feature or Bugfix
Purpose
Autosummary appears to be emitting 'autodoc-process-docstring' on docstrings that have already been processed by 'autodoc-process-docstring'. It does so by calling
Documenter.add_content, which calls itsprocess_doc, and then immediately callingprocess_docon the output. This PR removes the second call.I do not yet have a test, and advice on constructing one is welcome.Relates