nci / scores / 23227342373

100%

push

github

Issue 692 docstring cleanup (subset) (#996)

* Add docstring examples to contingency_impl and otherwise improve docstrings

* undoing raw docstrings

* Putting in automatic ruff code formatting

* Remove docstring formatting options

Removed docstring formatting settings from pyproject.toml.

Signed-off-by: Nicholas Loveday <48701367+nicholasloveday@users.noreply.github.com>

* Fixing odds ratio formula and ruff formatting

* Updating cawcr links

* Addressing concerns about example indentation and trailing whitespace
Also some linting issues about indicative tense at start of docstrings
and other things like too/many not enough blank spaces between things

* doctest modules now passes

AI Usage Summary: I (Tom) used claude code 2.1.78 to bring the code to compliance withdoctest-modules and then I went line by line to check every change. There were no changes of substance, but say a "2" becomes a "2.". In one case a "0" became a "-0" but that's just what scores produces as the answer. More generally claude was used to answer questions about how to write a docstring that conforms to the style guide, how to debug formatting issues and how to navigate the pull request process.

---------

Signed-off-by: Nicholas Loveday <48701367+nicholasloveday@users.noreply.github.com>
Signed-off-by: thomaspagano <tom.pagano@bom.gov.au>
Co-authored-by: Tom Pagano (he/him) <tompagan@bom.gov.au>
Co-authored-by: Nicholas Loveday <48701367+nicholasloveday@users.noreply.github.com>

466 of 466 branches covered (100.0%)

Branch coverage included in aggregate %.

3017 of 3017 relevant lines covered (100.0%)

4.99 hits per line