-
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!\…
-
# 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_
-
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 …
-
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]…
-
As changes have accumulated, many of the docstrings that the automated documentation is built off are either missing or outdated.
In order to ensure a correct and complete documentation, docstring…
-
For some styles of docstrings, particularly numpydoc, it may be possible to use the docstring to add type information to the signature, and a return type. For modules with appropriately-formatted doc…
-
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/…
-
While docopt can write great docstrings for the cli, it would be great to showcase their usages on a Readme page somewhere.