-
### Current Behavior
The docstrings that are currently used inside the project (`sphinx`) are not the same format as the new docstrings (`google`).
They should be changed to the new format.
### Exp…
-
- pydropsonde main()
- helper __init__
- processor
- pipeline
otherwise it's ugly in the api references
-
Many functions only take a few lines, so formatting docstrings like in the google docstring format may be nice
-
This issue is part of https://github.com/openjournals/joss-reviews/issues/6641.
As @roualdes has already mentioned in #95, the docstring for `predef_eeg` seems to be broken. Since this is likely on…
cbrnr updated
1 month ago
-
**Gammapy version**
1.2, dev
**Bug description**
The docstring of `EnergyDispersion2D` lists the following parameters for its constructor:
```
Parameters
----------
energy_axis_tr…
-
### Privileged issue
- [X] I am a LangChain maintainer, or was asked directly by a LangChain maintainer to create an issue here.
### Issue Content
We want to start enforcing that all public i…
-
This issue is to keep track of any concern regarding the HTML documentation generation, so we can adress them after the migration to pure Python is completed.
1. https://github.com/Crypto-TII/Crypt…
-
ReadTheDocs requires docstrings to have an additional newline between the header and the parameters if strings are not in this format it will not render properly. Therefore we want to put all docstrin…
-
Let's take the documentation of `Figure.plot` (https://www.pygmt.org/dev/api/generated/pygmt.Figure.plot.html#pygmt.Figure.plot) as an example. Currently, we use different ways to write bullet point l…
-
My preference goes to: Args, Returns, Example, References