Some of these grads are also confused by := as the assignment operator.
Name:
Anonymous2017-06-28 12:44
Example of proper documentation for complex software:
Tutorials: A step by step guide with heavily annotated code. These are meant to get the user acquainted with the library as quickly as possible. The objective is to build the confidence of the user in using the library through abundant examples and detailed instructions. Examples speak volumes and we have volumes of examples! Abstracts: A high level summary of key topics. The objective is to give the user a high level view of the library, the key concepts, background and theories. Reference: Detailed formal technical reference. We start with a quick reference -- an easy to use table that maps into the reference proper. The reference proper starts with C++ concepts followed by models of the concepts.