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

docs: Which table goes "flags" under? #1452

Merged
merged 1 commit into from
Apr 30, 2024

Conversation

MichalBryxi
Copy link
Contributor

Description

  • There is currently no indication under which table do "flags" go in the config file.
  • I think having that being explicitly spelled out & having an example saves quite a bit of people's time. Would for me 🙃

Issue

  • N/A, I just created a PR directly on GitHub, can spin up one if you want though.

Testing

  • N/A

Checklist

  • Areas your change affects have been linted using rustfmt (cargo fmt)
  • The change has been tested and doesn't appear to cause any unintended breakage
  • Documentation has been added/updated if needed (README.md, help menu, doc pages, etc.)
  • The pull request passes the provided CI pipeline
  • There are no merge conflicts
  • If relevant, new tests were added (don't worry too much about coverage)

- There is currently no indication under which [table](https://toml.io/en/v1.0.0#table) do "flags" go in the config file.
- I think having that being explicitly spelled out & having an example saves quite a bit of people's time. Would for me 🙃
@MichalBryxi
Copy link
Contributor Author

I don't think checking the things in the checklist make sense, but I left it there as deleting it also felt wrong.

@ClementTsang
Copy link
Owner

ClementTsang commented Apr 30, 2024

That seems like a reasonable change, thanks! Though in the future I'm planning on reworking how the config looks so hopefully it'll be a bit more obvious compared to me throwing everything under "flags".

Thanks for the PR!

@all-contributors please add @MichalBryxi for docs.

Copy link
Contributor

@ClementTsang

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I couldn't determine any contributions to add, did you specify any contributions?
Please make sure to use valid contribution names.

I've put up a pull request to add @MichalBryxi! 🎉

@ClementTsang ClementTsang merged commit e4f3b69 into ClementTsang:main Apr 30, 2024
12 checks passed
@MichalBryxi MichalBryxi deleted the patch-1 branch April 30, 2024 15:16
@MichalBryxi MichalBryxi restored the patch-1 branch April 30, 2024 15:16
@MichalBryxi MichalBryxi deleted the patch-1 branch April 30, 2024 15:16
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