Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add tarpaulin.toml configuration file example #1662

Merged
merged 4 commits into from
Dec 11, 2024

Conversation

basvandriel
Copy link
Contributor

This pull request adds a example configuration file, based on the src/config/mod.rs file. This is for better readability. I've also added a link to the mod.rs file.

@xd009642
Copy link
Owner

It's quite a lot of vertical space in the readme. Instead could you merge all the default fields that aren't already in https://github.com/xd009642/tarpaulin/blob/develop/tarpaulin.toml into there and retain the comments and just link people to the existing toml that the project uses 👀

@basvandriel
Copy link
Contributor Author

It's quite a lot of vertical space in the readme. Instead could you merge all the default fields that aren't already in https://github.com/xd009642/tarpaulin/blob/develop/tarpaulin.toml into there and retain the comments and just link people to the existing toml that the project uses 👀

Done! The null values have been commented out, since this gave syntax errors in the file.

@xd009642 xd009642 merged commit 9e42b24 into xd009642:develop Dec 11, 2024
21 checks passed
@basvandriel basvandriel deleted the feature/better-config-docs branch December 11, 2024 15:11
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