-
Each function will require a docstring. Existing functions with docstrings currently don't explain what the function should do. Update these to include parameters and return statements where necessary…
-
### Proposal
Currently, the docstring when overing on
```
set_option trace.Elab.command true
set_option trace.Elab.syntax true
…
```
always says
> enable/disable tracing for the given modu…
-
The goal of this issue is to get Ruff to lint and format attribute docstrings as already done for class/method/function docstrings.
[PEP 224](https://peps.python.org/pep-0224) is about attribute do…
-
Building the documentation with `sphinx-build` lets Sphinx uncover a whole range of issues in docstrings. Those need to be fixed.
-
## Positron Version:
Positron Version: 2024.06.1 build 27
Code - OSS Version: 1.90.0
Commit: a893e5b282612ccb2200102957ac38d3c14e5196
Date: 2024-06-26T01:22:29.024Z
Electron: 29.4.0
Chromium…
-
And host API docs on the website
-
The docstrings in `java-time.api` contain literal `\n` instead of newlines, which makes them hard to read in code. Cursive does not display them nicely either, but shows the documentation with the lit…
-
Please add docstrings to the React components in PersistentCheckbox.js and PersistentCheckboxList.js. The docstring should state what props the component takes as input, including the expected type, a…
-
Write docstrings for every function in the code.
-
### Checklist
- [X] I have searched the [existing issues](https://github.com/streamlit/streamlit/issues) for similar feature requests.
- [X] I added a descriptive title and summary to this issue.
…