[Advanced Rust] 2.9. API Design Principles of Obviousness - Documentation and Type System, Semantic Types, and Zero-Sized Types

2.9.1. Documentation and the Type System

Users may not fully understand all of an API's rules and restrictions. So your API should be easy for users to understand and hard to misuse.

With Rust's documentation and type system, we can try to achieve that.

2.9.2. Documentation

The first step toward making an API transparent is to write good documentation.