-
https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
-
### What happened + What you expected to happen
### **Description:**
There is an inconsistency between the docstring and the implementation of the `TorchLSTMEncoder` class in the RLlib new API.
…
-
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`
-
**Github username:** --
**Twitter username:** --
**Submission hash (on-chain):** 0x54188b0e8af8fc068b67df953fb04ed19789c0d093bc77877e7e7a916ea8d468
**Severity:** low
**Description:**
**Description**…
-
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…
-
### 📝 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 …
-
### System Info
class `CoherePreTrainedModel` docstring says that "This model inherits from [`PreTrainedModel`]. Check the superclass documentation for the generic methods the library implements for …
-
Would you find it reasonable to include something like https://www.chromium.org/chromium-os/python-style-guidelines#TOC-Describing-arguments-in-docstrings into argh?
```
def cmd(param):
"""
E…
-
### Steps To Reproduce
When you set the `SAGE_DOC_UNDERSCORE` environmental variable, the documentation is supposed to build with *all* functions, including the hidden/private ones which start with `…
-
## 📚 Documentation
Consider the following example: `napari.viewer.Viewer` subclasses `napari.components.ViewerModel`. These two classes then share parameters (arguments for their `__init__` method)…