Documentation overhaul
Issue #176
resolved
From our roadmap planning session, @vramasub and @bdice identified several ways to improve the documentation. Some of these are in progress.
- Fix module docstrings
- Fix all class/function docstrings
- Convert existing to Google style
- Seek input / revision from module authors where available
- Development Guide
- Add more detailed information on the standards for memory management
- Precisely detail the use of the different languages
- Discuss appropriate docstrings
- Add licenses for other software that we're using e.g. Eigen, TBB
- Create a thorough dependency list
Comments (2)
-
-
reporter - changed status to resolved
- Log in to comment
Most of this was addressed by Pull Request #180. The outstanding items are: