-
On pages with example options, or docstrings (e.g. [docstring examples](https://machow.github.io/quartodoc/get-started/docstring-examples.html)), showing rendered output would let users **see** what d…
-
Currently, the GUI outputs (dipole) simulation data ONLY into `csv` files, but the `Dipole` class outputs data ONLY to either custom `txt` or `hdf5` files.
# Subtasks:
- [ ] GUI and API output …
-
Currently, if someone adds an image, a list structure or an equation to their Python code documentation using reStructuredText, or if someone browses the documentation of existing libraries that emplo…
-
Some docstrings contain type info (as opposed to stubs or type annotations). This info should be parsed and used best-effort.
There are many different possible formats; numpy, google, epydoc, etc.
…
-
Most classes, methods, functions do not have any docstrings for documentation.
[PEP 0257](https://www.python.org/dev/peps/pep-0257/) describes the standard format
Single line
``` python
def kos_root…
-
In IPython, the _Returns_ and _Raises_ sections of our docstrings are often a single block of text, not a definition list. In particular, where functions return a single value, it seems awkward to giv…
-
This is a pain in the neck but I think migrating to `mkdocs` would pay off in the long run:
1. The build process is so much smoother and faster than Sphinx + RTD (live preview!)
2. Much more modern …
-
Below are what I feel we should do before we release the package to the public.
**Aesthetics**
- [x] Update the Readme with more information and examples.
- [x] Update the LICENSE.
- [x] Create …
-
## Environment data
- VS Code version: 1.44.0-insider
- Extension version (available under the Extensions sidebar): 2020.4.68586-dev
- OS and version: MacOS 10.15.3
- Python version (& dis…
mjbvz updated
4 years ago
-
## Documentation request:
tl;dr add a Contributing Guide page / section containing the most common and/or arcade-specific sphinx concerns
This is a follow-up to a [Discord conversation](https://…