-
-
The app files and unit tests to lack (although already present) sufficient docstrings, which makes the code less readable and maintainable. Adding docstrings will improve code documentation and help f…
-
Running
```sh
ruff check --isolated --select D301
```
on
```python
def foo():
"""
This docstring contains another docstring.
def bar():
\"\"\"Here it is!\…
-
### Discussed in https://github.com/PyO3/pyo3/discussions/4280
Originally posted by **djc** June 23, 2024
When I write a docstring on a `#[new] fn new()` method in a `#[pymethods]` `impl` bloc…
-
There still are several methods and classes that should have docstrings, but do not.
Run either `pylint --disable=all --enable=missing-docstring fabrictestbed_extensions/fablib/` or `interrogate -v…
-
# Description
Some of the magic contract reference docs are missing information about using the functions. Please add Solidity docstrings to the functions of the following contracts:
- [x] ISC
- [x]…
-
see format in #956
- [x] #955
- [x] #954
- [x] #946
bounty: 20 USD/per 5 docstring
_please specify which method/class you will be working on, and we will open a new issue for you_
-
Found using `Docs.undocumented_names` from 1.11.
They should also be added to the documentation when a docstring is created.
### Metal
- [X] `Metal`
- [X] `is_managed`
- [X] `is_private`
- [X]…
-
For many public APIs, JAX currently uses the `jax._src.numpy.util.implements` helper to define docstrings dynamically at runtime. This has several drawbacks:
1. The docstrings extracted from NumPy …
-
> NOTE: We are just about to have a major refactor of the codebase, so this should be done after #381 is merged.
It might be nice to make the api docs (auto build from the docstrings) more engaging…