CouncilDataProject / CouncilDataProject/cdp-backend
Clean up ingestion model docs -- specifically document attributes better
Open
documentation
enhancement
- Dominant language
- Python
- Stars
- 25
- Forks
- 28
- PR merge metrics
- No merged PRs in 30d
Description
https://councildataproject.org/cdp-backend/cdp_backend.pipeline.html#cdp_backend.pipeline.ingestion_models.IngestionModel
* each property should be documented
* try to hide the `from_json` and `from_dict` methods
* add example for every one
* mark each model as required or optional
Contributor guide
Assessment
This issue has not been assessed yet.