-
Hey! I've got a request similar to https://github.com/microsoft/pylance-release/issues/877 but related to class docstrings instead.
See the code below:
```python
class A:
"""
My docst…
-
`quartodoc` seems to fail on `Yield` portions of `docstrings`. I've raised a [ticket](https://github.com/machow/quartodoc/issues/338). Currently these are simply commented out via `#` symbols, so `doc…
-
If I write a comment above a function it is shown as the function's docstring while hovering over the function. I want to disable this behaviour in case by case basis. For example if I have something …
-
### Current problem
currently there is no way to enforce adding docstrings to constants or types.
Since 3.9 it is possible to properly annotate constants or types via:
```
from __future__ import…
-
If a user is linting sphinx-style docstrings, pydoclint should be able to detect whether docstrings deviating from the selected style, such as google/numpy, are present and raise a violation.
-
## Description
Replace Numpy Docstrings for Google Style in Backend
## Context
There're remaining Numpy style docstring and we wan't to unify all backend docstrings.
[Numpy style](https://…
-
I think it is a bit easier for our future selves if we have have a usage example in the docstring.
Something like
https://github.com/kausalflow/hamilflow/blob/04ea13c523f8beb7d48123754ec96251b98b5…
-
Apologies if I have missed a setting. I cannot find an easy way to document the `__init__` method for equinox modules, which uses the same default generated `__init__` methods as dataclasses.
```pyth…
-
Current doc string:
```julia
julia> ?image
image(x, y, image)
image(image)
Plots an image on range x, y (defaults to dimensions).
```
Just spent 10 min to figure out that `x, y` must …
-
Hi, I hit some friction when setting up my local development environment on Debian-based [gLinux](https://en.wikipedia.org/wiki/GLinux). I used the [Get started](https://pydata-sphinx-theme.readthedoc…