-
Many of the modules and classes are missing docstrings which make the API section look bare and the appearance could be improved.
The top modules (mmm and clv) may require to be edited in the docs/…
-
Like PyCharm:
![image](https://github.com/DetachHead/basedpyright/assets/65446343/a949d22a-8cfb-4412-ab8a-edd8a5803660)
-
Develop a system for writing docstrings that is comprehensive and will be of use to future developers, and for overwriting class methods for implementing behaviour.
Section in docs that use autodoc…
-
We should check all docstring so that they match in the format. Add examples where needed.
-
Split off from #261,
https://pybind11.readthedocs.io/en/latest/advanced/misc.html#avoiding-cpp-types-in-docstrings
Basically the class declarations need to appear before the methods which involve …
-
The methods that google-api-python-client generates at runtime actually has docstrings. It would be useful to add these in the stubs so that they're shown in your IDE
-
- https://github.com/python-rope/rope/pull/797
- Lots of build errors because people keep referencing parameters as `` `param` `` in docstrings
- But that would be exactly the way to reference t…
-
I posted a comment in #243 but am not sure that will be seen since that issue is closed. I have
```
% docformatter --version
docformatter 1.7.5
```
and the fix from that issue appears to apply on…
-
Make sure that all user facing function as a clear example.
-
Making a running list of files that do not have docstrings in the main branch