Style guide¶
This page explains Style guide and how it fits into the RecSys suite.
- Keep comments ASCII.
- Prefer small focused packages.
- Avoid cleverness; optimize for readability.
- Keep public APIs minimal.
Documentation:
- Prefer short sections.
- Use concrete examples.
- Explain the "why" in explanation docs.
Read next¶
- Developer workflow: Developer workflow
- Documentation approach: Documentation approach
- Start here: Start here