Description
We would like to improve cuSpatial's developer documentation to make it easier to contribute to cuSpatial.
I think we should follow the lead of cuDF, which has a relatively comprehensive set of documentation for developers. cuDF provides a library_design.md which provides an overview of the core classes and their relationships. It also provides documentation.md which documents how developers should write docstrings for cuSpatial Python APIs.
cuDF is in the process of further improving its Python developer guides, which will provide even better examples for cuSpatial. For example, there are PRs for creating the main Python developer guide, adding developer docs for writing tests,, and adding developer docs for benchmarking. (All by @vyasr)
In addition to developer docs, cuDF also provides a comprehensive user guide. This is helpful to developers as well as to users. We should consider this for cuSpatial as well.
Metadata
Type
Projects
Status
Done