Documentation: quick reference

Issue by schuyler1d
Tuesday Jan 13, 2015 at 22:02 GMT

For earlier discussion, see https://github.com/rust-lang/rust/issues/21112

This issue was labelled with: A-docs in the Rust repository

Something to think about in terms of the developing suite of documentation is a quick-reference. In python, I use this all the time:
http://rgruet.free.fr/PQR27/PQR2.7.html

Maybe this is more 'for those that live in non-IDE editors', but even as a more advanced user of python, I find it's still a very useful doc -- basically a one-pager of built-in types/syntax/structure and important standard libraries (and maybe even beyond since some important ones will be out of the std library).

Specifically, it aims for compactness rather than complete explanations -- think of it as for someone that has read through the doc and is a beginner/mid-level experience programmer, but 'just can't remember what the method on String is, or "what's the exact command line argument?"

Not sure if it's possible to auto-generate this kind of thing -- maybe a 'combine all the docs' without the explanation strings?

Start by reading the earlier discussion in Rust issue 21112 and reviewing the current documentation suite. Determine the proposed quick-reference scope for Rust syntax, built-in types, standard libraries, and command-line arguments; the issue does not identify files, tests, or a concrete completion criterion.