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

Add a ton of links :) #16

Open
killercup opened this issue Mar 20, 2017 · 3 comments
Open

Add a ton of links :) #16

killercup opened this issue Mar 20, 2017 · 3 comments

Comments

@killercup
Copy link
Contributor

killercup commented Mar 20, 2017

Very nice, I really like your style of writing! It's a bit more sudden in introducing new things, and mentions a lot of nice details on the side. I only wish you'd add some links to learn more about that :)

For example, here, when you introduce formatting syntax with println!("{:.1} ",x);, people might wonder where they can lear more about this, so why not add a link to the std::fmt docs? (This is also one of the most underappreciated parts of the std docs!)

Or, when you introduce Option, Vec, Iterator, etc. and present a few methods – their API docs have so many other interesting things!

@stevedonovan
Copy link
Owner

You're quite right - just saying 'like Python' is a bit throwaway. Yeah, the more links the better - and there are some brilliant sections of the documentation like std::fmt. I suspect I 'underwrite' a bit, need to flesh out those interesting details.

@torkleyy
Copy link
Contributor

Links between the pages would be nice, too.

@stevedonovan
Copy link
Owner

That's one of those ideas which are obvious in hindsight. It's not really a book and I can refer back to earlier sections.

Another thing I'm thinking of, is providing links to the source. The src directory has a lot of little test programs, and I may be able to persuade mdbook to render them for me.

As I go through the text, I'm putting in as many doc links as possible. There's even a section on how to read the docs (start of section 5) because man the first time I saw them I was scared (and I don't scare easily)

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

3 participants