Optional file option v2 #171
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
Support cases where _get_filenames() for non-autodoc directives may return None. Can't convert NoneType to a list.
If no file option is provided, iterate over all previously parsed files, and see if the symbol can be found in them. This implicitly matches symbols from any previously parsed files. The :file: option can still be provided to restrict to symbols from a specific file. If the symbol matches in multiple files, insert them all, and warn.
As the cli tests only support the autodoc directive, we don't need to support the missing file option. However, ensure with an assert the file is specified.
Split the handling to parsing and output phases, similar to the extension.
Test looking up symbols from previously parsed results by dropping the file option from the second directive in autostruct.yaml.
Document how the :file: option works now that it is optional.
jnikula
force-pushed
the
optional-file-option-v2
branch
from
181d924
to
70859f0
Compare
This was referenced Jul 29, 2023
Closed
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 is based on #170 and includes everything that one has, but this finishes the job. File option beccomes optional, and it's tested (although lightly).