-
### Issue with current documentation:
* The transition guide [here](https://numpy.org/doc/stable/reference/routines.polynomials.html#transitioning-from-numpy-poly1d-to-numpy-polynomial) does not expl…
-
### Steps to reproduce:
* Read source: "`source/addonHandler/__init__.py`", or
* Use the NVDA python console to:
```
import addonHandler
help(addonHandler.initTranslation)
``…
-
**Is your feature request related to a problem? Please describe.**
For modules with mathematical correlations/equations, the code can sometimes be much shorter than the docstring - especially when La…
-
I'm working on a `conda-lock`-ish custom tool for my company's build system. The py-rattler API is great! But I'm noticing many `__init__` functions are missing from the documentation, so I'm consul…
-
Adding ANSI color support to `@example` blocks in #1441 was a great addition, and I'm wondering if we could have colorful reference documentation too?
Say I have a docstring with ANSI colors in the…
-
Given some existing config dataclass, I would like to parse arguments to create the config.
Example:
```python
import sys
from cyclopts import App
@dataclass
class MyConfig:
a: i…
-
**Describe the bug**
The text included in the `"""docstring"""` at the top of a module is not "rendered" in the Markdown. For instance, the [main example](https://github.com/vemel/handsdown/blob/main…
-
I propose we not only write, but also generate documentation to make user's lives easier.
See https://github.com/RookieGameDevs/revived/tree/master/revived and https://revived.readthedocs.io/en/sta…
-
Hi,
I'm trying to generate docs (with `mkdocstrings` + `Griffe`) for some Rust structs like the one below:
```rust
/// Some Object O
#[gen_stub_pyclass]
#[pyclass(get_all)]
struct O {
//…
-
### Description
Some commands such ``*GET``, ``TB`` and many more have very long documentation in the command reference. I feel like, it is very long. Some Note sections cover all the possible conf…