-
# Documentation
The documentation on text handles is misleading, in particular for the `seek` method.
# Steps to reproduce
```
handle = open('/tmp/lines.txt')
help(handle.seek)
```
This…
-
Two docstrings in `core/scaling/pre_scaling.py` contain backslashes which, when brevitas is imported during a pytest, issue errors:
```
File "/__w/concrete-ml/concrete-ml/.venv/lib/python3.8/sit…
-
See https://hynek.me/articles/document-your-tests/
-
### Problem description
The docstrings for the pl.List and pl.Array dtypes are quite terse. They could probably be improved with some text to explain their respective use cases and an example of how …
-
- [ ] remove `compute_drop_volume_total_volume_ratio` from `example.py`
- [ ] remove `get_pysdm_secondary_products` from `example.py`
- [ ] beef up docstrings (e.g., """interprets parameters from Sr…
-
Greptile: Add docstrings to backend/services/genai.py file
-
For example, `csp.ticked` is mentioned but could benefit from having its docstring exposed. This is probably true for other objects as well.
We can use this issue to capture a list of objects that …
-
Code being added should ideally have type-hinting and docstrings to improve maintainability and usability.
-
I propose to deprecate that a docstring makes a method public
I think it is too implicit given we have a working permission declaration system for years now.
Making it deprecated could already be do…
-
- [x] The docstring formatting is inconsistent. Some functions use a numpydoc format while others use a GoogleDoc (?) style format (e.g. https://github.com/Aminsinichi/wearable-hrv/blob/ac22c3784c3952…