-
# Handle
evertkors
# Vulnerability details
A lot of docstrings for marketIndex are ` @param marketIndex An int32 which uniquely identifies a market.` but it is a `uint32` not an `int32`
-
Pydocstyle has a setting to specify the used docstring convention:
```
[tool.ruff.lint.pydocstyle]
convention = "google"
```
Pylint also has rules for docstrings and profits from setting the …
-
I'd like to help in creating docstrings for the functions.
-
### Description of the bug
Line of code is shown on attributes.
For example on `shape` and `fill_value`:
https://sparse.pydata.org/en/latest/api/COO/#sparse.COO-attributes:~:text=shape%20%3D%…
-
All docstrings need to be checked to make sure they make sense, and also that the strings reference the correct variable names as I switched from camelCase to under_scores in my variable naming conven…
-
### Prerequisites
Please put an X between the brackets as you perform the following steps:
* [X] Check that your issue is not already filed:
https://github.com/leanprover/lean4/issues
* …
-
### Why is this Important?
- Good comments and documentation make the code more understandable and maintainable.
- They provide context and explain why the code is written the way it is.
- They…
-
The google style guide for instance class attributes is here: https://google.github.io/styleguide/pyguide.html#384-classes
The example they provide is:
```
class SampleClass:
"""Summary of…
-
Current state:
- Images from readme are missing.
- There's no menu.
- There doesn't seem to be any link to the docstring docs.
![Screenshot 2024-09-18 at 10 05 08 AM](https://github.com/user-a…
-
### 📚 Documentation Improvement
Links to documentation pages are broken e.g.:
https://docs.deci.ai/super-gradients/docstring/training/metrics.html#training.metrics.detection_metrics.DetectionMet…