search

NSAPH-Projects / space

SpaCE, the Spatial Confounding Environment, loads benchmark datasets for causal inference methods tackling spatial confounding
https://nsaph-projects.github.io/space/
MIT License
14 stars 5 forks source link

Improve Documentation Across All Classes and Functions #56

Closed Naeemkh closed 1 year ago

Naeemkh commented 1 year ago

There are several classes and functions in our codebase that lack sufficient documentation, particularly regarding their arguments. This issue aims to address and rectify this gap.

The goal is to ensure that all classes and modules in the project have comprehensive and clear documentation. The documentation should include, but not limited to, an overview of what each class or function does, descriptions of all arguments and their expected types, and what the function returns if applicable.

This task will be considered successful when every class and function in the project is properly documented, enhancing readability and maintainability of our codebase.

mauriciogtec commented 1 year ago

Closing since this issue was for release v0.0.2; we can now complete the v0.0.2 milestone.