Optional file option prep work #169
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
Add a dedicated type for the root docstring returned by the parser, with information about filename and clang args used for parsing it.
Follow the hawkmoth naming more consistently with s/cautodoc_parsed_files/hawkmoth_parsed_files/
Move all of the parameter handling in __get_clang_args()
Handle the parsing and docstring insert in two separate steps.
Count matches across all files. In the future, we'll be interested in more cases than just 0 and 1.
Prepare for multiple matches across multiple files, and warn about them. Note that the autodoc directive matches all the symbols in a file, without filtering by name, so it by design matches multiple symbols. Don't warn about that.
In preparation for not requiring the :file: option for directives, start iterating over the parsed results, and filtering them using the directive specific information.
Now that parsing is a separate step, the results are no longer needed while parsing.
|
Looks good! Good idea to split it too. |
Thanks for taking the time to look at this! |
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 all the prep work from #168 without the actual functional change of making the
:file:option optional. I also dropped the generator removal change, and usedlist()around the caller instead.I figured this one doesn't really need specific tests, while I figure out how to test the rest of the changes.