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(generate): Improve jumping off points #2720

Merged
merged 2 commits into from
Aug 18, 2021
Merged

Conversation

epage
Copy link
Member

@epage epage commented Aug 18, 2021

This provides a skeleton README for clap_generate, including a
one-line summary and a link to the docs to guide people to the examples
there.

In doing so, I tried to clarify and be consistent in what role
this crate plays. While it is very general, being too general in the
description can lead people to not understand where they could use it.

Fixes #1711

clap_generate/README.md Outdated Show resolved Hide resolved
@pksunkara
Copy link
Member

What do you think about some small blurb about getting started in src/lib.rs as doc for the library at the beginning?

This provides a skeleton README for `clap_generate`, including a
one-line summary and a link to the docs to guide people to the examples
there.

In doing so, I tried to clarify and be consistent in what role
this crate plays.  While it is very general, being too general in the
description can lead people to not understand where they could use it.

Fixes clap-rs#1711
@epage
Copy link
Member Author

epage commented Aug 18, 2021

What do you think about some small blurb about getting started in src/lib.rs as doc for the library at the beginning?

Directed people to some next steps but I've kept it limited to not grow the scope of this PR. In writing this, I've noticed some polish that clap_generate could use, like

  • impl ArgEnum for Shell, which will require including the derive traits without the derive feature which I think we should do
  • ArgEnum::generator(self) -> &dyn Generator

With those in place, we can tell a better story for how to use clap_generate (even better is to provide clap::Args and clap::Subcommand impls, even if hand-generated, to get people up and running faster, whether using derives or builder, see #810).

@pksunkara
Copy link
Member

even better is to provide clap::Args and clap::Subcommand impls, even if hand-generated, to get people up and running faster, whether using derives or builder, see #810

Yup, that was my plan to fix that issue.

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.

Point clap_generate README to docs.rs
2 participants