-
Is there a way to make `autodoc2` work with NumPy-style docstrings?
-
## Issue
To make our chat model integrations as easy to use as possible we need to make sure the docs for them are thorough and standardized. There are two parts to this: updating the chat model do…
-
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…
-
Add additional auto linting rules to the github runner.
Additional rules required include but are not limited to:
- [ ] All function/method parameters must have type annotations in-code.
- [ ] Al…
-
Some methods already have thorough documentation, for example:
https://github.com/zowe/zowe-client-python-sdk/blob/5816aab8746e2a137f0b6959d596d6886ecf6ba0/src/zos_files/zowe/zos_files_for_zowe_sdk/f…
-
It is very helpful to have an `Examples` section in the docstring of functions.
Specially for `gammapy.maps` and `gammapy.estimators` where its often unclear what slices need to be passed as argument…
-
### Did you check the docs?
- [X] I have read all the todo-comments.nvim docs
### Is your feature request related to a problem? Please describe.
No
### Describe the solution you'd like
TODO highl…
-
**What problem or use case are you trying to solve?**
In some cases, arguments mentioned in docstrings have become stale, and no longer match the actual function signature. It would be better if we…
-
When trying to buld the docs for a package I ran across this error message after running `docs/make.jl`:
```
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doct…
-
Currently, 2120 functions in `bim2sim` don't have a correct docstring. If you want to check the current status, I added a function to get all functions without docstrings to utilities in branch https:…