fix: Do minimum work when falling back to re-collecting an object to get its anchor #330
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
…get its anchor This change introduces a new attribute on collectors: `fallback_config`. It is used by the `Handlers.get_anchor` method when collecting an object to find its anchor. It allows to pass specific options to the collector to avoid collecting the object members or, for example, parsing Python docstrings, as it is not useful, since we only care about the anchor. Issue #329: #329 PR #330: #330
|
Maybe we could call it |
oprypin
approved these changes
Oct 10, 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.
This change introduces a new attribute on collectors:
fallback_config.It is used by the
Handlers.get_anchormethod when collecting an objectto find its anchor. It allows to pass specific options to the collector
to avoid collecting the object members or, for example,
parsing Python docstrings, as it is not useful,
since we only care about the anchor.
Fixes #329
It requires pytkdocs v0.14 which added Mardown "style" support: mkdocstrings/pytkdocs#121