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

README documentation/examples aren't discoverable from rustdoc docs #293

Closed
huonw opened this issue Oct 1, 2015 · 2 comments
Closed

README documentation/examples aren't discoverable from rustdoc docs #293

huonw opened this issue Oct 1, 2015 · 2 comments
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations

Comments

@huonw
Copy link
Contributor

huonw commented Oct 1, 2015

Looking at http://kbknapp.github.io/clap-rs/clap/index.html, there's no indication that I can see that the wonderful README and in-tree examples exist. It'd be great if the crate at least had a brief header with a link, or even if most of docs in the README were moved to be in the rustdoc docs (especially the examples, like for the clap_app! macro).
@kbknapp
Copy link
Member

kbknapp commented Oct 1, 2015

Good idea! We used to have the full Readme in rustdoc but pulled it out when it started to get out of date. I'll add the relevant parts back as I agree with you. Thanks 👍

@kbknapp kbknapp added C-enhancement Category: Raise on the bar on expectations A-docs Area: documentation, including docs.rs, readme, examples, etc... D: easy labels Oct 1, 2015
kbknapp added a commit that referenced this issue Oct 1, 2015
@kbknapp
docs(Rustdoc): adds portions of the readme to main rustdoc page
264b06d 
Closes #293
@kbknapp kbknapp closed this as completed in 6f9ee18 Oct 1, 2015
@kbknapp
Copy link
Member

kbknapp commented Oct 1, 2015

#302 actually closes this...wrong comment style before 😜

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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@huonw @kbknapp