-
For Bazel newbies, it would be helpful to add docstring documentation to the code in openroad.bzl to explain what the code is doing. This is especially important for important methods like _make_impl,…
-
### 📚 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…
-
### 📝 Describe the issue with the documentation
We need proper linting for google style docstrings
### 💡 Suggest what to add or change
Follow the Ruff guide for docstrings linting - the "D" Family …
-
- [ ] solver_default => provide docstring
- [ ] predict_partial_overlap => make explanation for documentation
- [ ] extend_to_larger => provide docstring
-
It would be nice to make `@Block` a public interface.
One step towards this would be to make `@Block` use `make_block_docstring` from its own namespace, so users didn't have to import make_block_do…
-
Please make an effort adding better docstring to the code.
For example `help(learner.validate)` outputs only this minimally useful message.
```
validate(ds_idx=1, dl=None, cbs=None) method of …
nkrot updated
11 months ago
-
Using the crate, I was surprised that it only supports documenting of types.
I understand that the current code does not directly support it as it uses a derive macro, but I think the ability to e…
-
For this, I use the sphinx version that comes in `requirements.txt`, since sphinx can be wildly different between versions. We can change that eventually if it fixes things.
To create the documenta…
-
https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
-
The formatting for the service function docstrings seems to be stripped at some point. I specifically was comparing `aws sts get-session-token help` to `STS.get_session_token`