-
We should have ~a `/documentation` path~ [docstring](https://fastapi.tiangolo.com/tutorial/path-operation-configuration/#description-from-docstring) for endpoints that points to the online documentati…
-
- pydropsonde main()
- helper __init__
- processor
- pipeline
otherwise it's ugly in the api references
-
Parent Issue: #58063
pandas has a script for validating docstrings:
https://github.com/pandas-dev/pandas/blob/6a7685faf104f8582e0e75f1fae58e09ae97e2fe/ci/code_checks.sh#L92-L105
Currently, …
-
The tests are failing if autodocsumm is getting build and tested within a Python 3.13 environment. The failure is looking always the same.
```python
self = , args = ()
kwargs = {}, content = 'bot…
-
Many functions only take a few lines, so formatting docstrings like in the google docstring format may be nice
-
Very few of the [top-level functions](https://github.com/zarr-developers/zarr-python/blob/498cb788b29900183dbcfd7633c48afd5cee8a95/src/zarr/__init__.py#L37-L67) have doctrings. This is bad and we shou…
d-v-b updated
2 weeks ago
-
-
I don't know if any tool does this at the moment, we may need to write our own logic for it
But, it'd be pretty cool, especially as we're showcasing type hints in docstrings now
-
ReadTheDocs requires docstrings to have an additional newline between the header and the parameters if strings are not in this format it will not render properly. Therefore we want to put all docstrin…
-
The new version wrapping Python docstrings adds ` * ` prefix to lines, if the comment starts on the docstring line.
Input:
```
def a():
""" a a a a a a a a a a a a a a a a a a a a a a a a a …