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.

Sign up for GitHub

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

Jump to bottom

Single-source feature documentation #3387

Open
2 tasks done
epage opened this issue Feb 2, 2022 · 2 comments
Open
2 tasks done

Single-source feature documentation #3387

epage opened this issue Feb 2, 2022 · 2 comments
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations S-triage Status: New; needs maintainer attention.

Comments

@epage
Copy link
Member

epage commented Feb 2, 2022

Please complete the following tasks

  • I have searched the discussions
  • I have searched the existing issues

Clap Version

master

Describe your use case

Right now we document features in both the Cargo.toml and README.md.

Describe the solution you'd like

Only have one place to document them, ideally where they are defined.

Alternatives, if applicable

No response

Additional Context

Check out https://docs.rs/document-features/latest/document_features/ as a potential solution
@epage epage added C-enhancement Category: Raise on the bar on expectations A-docs Area: documentation, including docs.rs, readme, examples, etc... E-easy Call for participation: Experience needed to fix: Easy / not much labels Feb 2, 2022
@anshulrgoyal
Copy link

@epage Is this still open? If yes, can i work on this?

@epage epage removed the E-easy Call for participation: Experience needed to fix: Easy / not much label Oct 7, 2022
@epage
Copy link
Member Author

epage commented Oct 7, 2022

Yes, but understand this is more experimental: it is unclear whether this would be worthwhile or not, that is to be determined in the doing. So there is a chance the PR could get rejected and this issue closed.

@epage epage added the S-triage Status: New; needs maintainer attention. label Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations S-triage Status: New; needs maintainer attention.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@epage @anshulrgoyal