fix: deduplicate entries in children and references #61
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
dandhlee
added
the
type: bug
google-cla
bot
added
the
cla: yes
tbpg
reviewed
Jun 25, 2021
docfx_yaml/extension.py
Outdated
Comment on lines
634
to
635
| # Checking in dictionary("{}") takes O(1) average time for a bit more space, | ||
| # whereas checking in lists("[]") takes O(n) average time. |
There was a problem hiding this comment.
Not sure we need this, but it doesn't hurt. Using a dict as a set is standard.
docfx_yaml/extension.py
Outdated
| @@ -626,6 +628,15 @@ def process_docstring(app, _type, name, obj, options, lines): | |||
| """ | |||
| This function takes the docstring and indexes it into memory. | |||
| """ | |||
|
|
|||
| # Check if we already processed this docstring. | |||
| if name not in app.env.docfx_uid_names: | |||
There was a problem hiding this comment.
I would flip this, returning early if it's already processed. Then, you don't need the else.
|
Thank you! Ready for review :) |
tbpg
approved these changes
Jun 28, 2021
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.
Before you open a pull request, note that this repository is forked from here.
Unless the issue you're trying to solve is unique to this specific repository,
please file an issue and/or send changes upstream to the original as well.
There was an issue with the way Sphinx imports docstrings, and processes certain items twice in
process_docstringfunction. Instead of checking for duplicate entries in the children/reference, we'll check to see if we've already processed a docstring or not and solve it from the root cause.Fixes internally filed issue