-
We need docstrings on the header of the file to improve readability.
-
The DMC components have top-level descriptions that are just their names, for example:
https://github.com/snehilvj/dash-mantine-components/blob/6dcf035b31cb52e7ebdf30d43dae2942a66f51a5/src/ts/compo…
-
In function docstrings, for the section describing the input arguments, we use both `Arguments` and `Parameters`. I think `Arguments` is more common, but `Parameters` occurs a couple of times. We shou…
-
https://github.com/JDACS4C-IMPROVE/IMPROVE/tree/develop/improvelib/config
-
# Bug report
### Bug description:
As mentioned [here](https://github.com/python/cpython/issues/124984#issuecomment-2477870588), apparently I stripped some of the docstrings while switching things ov…
-
### pdstools version checks
- [X] I have checked that this issue has not already been reported.
- [X] I have confirmed this bug exists on the [latest version](https://pypi.org/project/pdstools/) of …
-
Here we can list Doc strings that need to be revised either because they are unclear or incomplete or because their formatting is not correct or inconsistent. Afterwards, we can also have a look at th…
-
-
Originally docstrings were only in the C sources, but not in the header files.
As a part of doing the CBMC proofs, we pulled most of the docstrings to the headers files, but not all.
Now it is rat…
-