Skip to content

TOML File Support#10

Merged
Yash-Agrawal10 merged 43 commits intomainfrom
yash-toml-file
Nov 13, 2025
Merged

TOML File Support#10
Yash-Agrawal10 merged 43 commits intomainfrom
yash-toml-file

Conversation

@Yash-Agrawal10
Copy link
Collaborator

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.

@Yash-Agrawal10 Yash-Agrawal10 merged commit 09599a5 into main Nov 13, 2025
4 of 5 checks passed
@Yash-Agrawal10 Yash-Agrawal10 deleted the yash-toml-file branch November 13, 2025 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants