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

Document cargo features in readme #299

Open
rukai opened this issue Jul 24, 2023 · 1 comment
Open

Document cargo features in readme #299

rukai opened this issue Jul 24, 2023 · 1 comment

Comments

@rukai
Copy link
Contributor

rukai commented Jul 24, 2023

Users who use this crate as library will very likely want the cli feature disabled and its also not clear to me what the nameattr feature is for even after looking at the code.
So a section in the readme or maybe the root of the crate docs that lists what every feature is and which are enabled by default would be really valuable.

@jonhoo
Copy link
Owner

jonhoo commented Aug 13, 2023

I completely agree! I really wish there was a standard way to document features in Cargo/the Rust ecosystem. There's some discussion in rust-lang/api-guidelines#43, but no hard guidance as of yet. @itamarst maybe you could take a stab at this after you land #294?

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

No branches or pull requests

2 participants