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

Fix link to Builder API in README #3345

Merged
merged 1 commit into from Jan 25, 2022
Merged

Fix link to Builder API in README #3345

merged 1 commit into from Jan 25, 2022

Conversation

dgellow
Copy link
Contributor

@dgellow dgellow commented Jan 25, 2022

  • "Builder API" was a link to https://docs.rs/clap, which is incorrect. Fixed it with a link to the tutorial.
  • Updated "Derive API" to also target the relevant tutorial instead of the list of examples.

@epage
Copy link
Member

epage commented Jan 25, 2022

If I'm understanding correctly, neither of these links are "incorrect" but links to reference documentation and you are switching them to tutorial documentation.

Is that correct?

Whats the motivation for the preference on tutorial?

@dgellow
Copy link
Contributor Author

dgellow commented Jan 25, 2022

The "Builder API" link is incorrect, it redirects to the page you're already at when you read the documentation from https://docs.rs/clap/latest/clap/. You can try yourself by clicking by going to the docs.rs page and click on this link, it's just refreshing the same page:

image

I linked to the tutorial instead of the list of example because it does a better job at explaining what the APIs are, while also having links to the examples.

@epage
Copy link
Member

epage commented Jan 25, 2022

The "Builder API" link is incorrect, it redirects to the page you're already at when you read the documentation from https://docs.rs/clap/latest/clap/. You can try yourself by clicking by going to the docs.rs page and click on this link:

Good point. The context of coming from docs.rs is a help.

I linked to the tutorial instead of the list of example because it does a better job at explaining what the APIs are, while also having links to the examples.

I can buy that. Thanks for explaining,

@epage epage merged commit 5ccffb0 into clap-rs:master Jan 25, 2022
@dgellow
Copy link
Contributor Author

dgellow commented Jan 25, 2022

To be honest, I personally don't really mind if it targets the tutorial or the examples, I went for what I thought was the best choice but I'm fairly new to the project.

I'm sure that you know better than me what is the correct page to link to, feel free to change to what you think is a better page :)

@dgellow dgellow deleted the patch-1 branch January 25, 2022 19:32
@dgellow
Copy link
Contributor Author

dgellow commented Jan 25, 2022

Oh, that was quick! Thanks for merging it :)

Edit: also, I noticed that you rephrased the commit message, thanks for this, that reads way better than my short one! 👍

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.

None yet

2 participants