-
I noticed that several functions in the file pytest/src/_pytest/main.py, specifically between lines 245 and 490, are missing docstrings and inline comments. I propose adding Sphinx-compatible docstr…
-
Hi guys. Thanks for releasing and mantaining pdoc.
In my codebase, I have a class that inherits from an abstract class, and within this derived class, I have methods named "compute" that are decora…
-
* SHARC version:
* Python version:
* Operating System:
### Description
Add missing docstrings to code in the `development` branch.
We'll use [Google style docstrings](https://google.github.io…
-
- [ ] docstring spacing is all messed up.
- [ ] docstrings are in numpy style; google style would be better
- [ ] doctests should be added throughout
- [ ] unittests tests are more like a hybrid hy…
-
https://www.pyopensci.org/python-package-guide/documentation/write-user-documentation/document-your-code-api-docstrings.html
We have the above page in our guidebook but a more robust page on the di…
-
## Description
Replace Numpy Docstrings for Google Style in Backend
## Context
There're remaining Numpy style docstring and we wan't to unify all backend docstrings.
[Numpy style](https://…
-
When using functools.wraps to decorate functions, Pylance does not show the docstring and related metadata for the wrapped function. However, typing func.__doc__ does return the correct docstring, sug…
-
```
/vsts/agent/_work/2/s/third-party/pcm/src/cpucounters.h:483:10: error: duplicated command '\brief' [-Werror,-Wdocumentation]
//! \brief metrics metric set (see the ServerUncoreMemoryMetrics …
-
See https://github.com/lightly-ai/lightly/issues/1216 for more information
-
This is only something to be done before the release, but i have been **very sloppy** with docstrings in the python API, therefore, basically every docstring needs to be checked, I fear...