Add poper docstrings on the whole codebase

[Pierre-VF]

Currently, docstrings do not cover the whole codebase. We should have a much better coverage of this in functions and classes.

Format for the docstrings should be reStructuredText for consistency

[github-actions]

🤖 This is an automated response from Repo Assist.

Looking at the codebase, a few observations that might help prioritise the effort:

Good news: module-level docstrings are already present in most files (e.g. parsers/__init__.py, parsers/licenses.py, models.py), and a handful of classes and methods have docstrings too (ParsingTargets, ResourceListing). So the reST format baseline is already established.

Main gaps: most individual functions (especially in parsers/git_platforms/, nlp/, and the app routers) lack function-level docstrings.

Suggested approach for tackling incrementally:

1. Enable ruff's D rules (pydocstyle) in pyproject.toml to get a count and enforce coverage going forward — even just D100/D101/D102/D103 (missing docstrings on public modules/classes/methods/functions) would surface all gaps without being too strict about format yet.
2. Prioritise public-facing API — the router endpoints in src/oss4climate_app/src/routers/ and the git platform parser classes in src/oss4climate/src/parsers/git_platforms/ are the most useful for new contributors and worth documenting first.
3. Add docstrings incrementally in PRs alongside other changes, rather than one large PR, to keep reviews manageable.

Happy to help draft docstrings for specific modules if that would be useful!

Generated by Repo Assist · ◷

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@9646d0870492f62bd9a67b4d38ddfbb731f7e0a4