Merged
Conversation
and ignore dead doc comment warnings
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 support for documentation of both local and non-local functions using a sniff-test.toml file included at the root directory of a cargo project. Integrates with the newly simplified docstring parsing to support identical syntax to in-code sniff test documentation.
This is primarily done by creating an additional toml module within the annotations module, and passing around a TomlAnnotation object to functions that at some point need to check functions for docstrings, along with the already passed TyCtxt. If needed, we could later make a struct that encapsulates all the information needed to check functions for docstrings, but currently these are passed separately.
There are a few very brief tests included in tests/toml which demonstrate how the toml file works.