Draft
Conversation
This file contains hidden or 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
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.
Adds a tag
@include <path>which adds the content of the file atpathto the doc entry description. The tag is allowed to appear multiple times.This pull request also moves diagnostic stuff around a bit so doc entries always gather all their diagnostics before returning an Err. Due to
diagnosticsbeing instantiated before looping through tags, I thought there was no benefit to waiting to add diagnostics for unused tags (as previously thediagnosticsvector would only be created if there were any unused tags), so I have also inlined unused tag diagnostics.Todo
@includetag path is assumed to be based from the current working directory, meaning it checks the cached folder. The extractor should really check from the base path, the one provided via the--baseflag. I am not sure about the best way to go about this.main.rspasses the base path togenerate_docs_from_pathwhich uses it for getting human-readable paths, and that is it. Sharing the base path in a module would not even work really since the base path only exists if theextractsubcommand is used./extractor/test-input/.Closes #185