-
The recent PR https://github.com/sktime/sktime/pull/7231 adds an API reference page for in-memory data representation.
With this, detailed documentation on the most commonly used time series machin…
-
We need to clarify and uniformize `model_path` parameters in the foundation models.
There are two problems we need to address:
1. Currently the docstrings are not clear what `model_path` can be.…
-
#### Problem Description
As noted in #143 , many Python projects use the format `:param : ` or `@param : `, but this format for documenting function parameters is not recognized by pdoc.
#### Pro…
-
Many functions only take a few lines, so formatting docstrings like in the google docstring format may be nice
-
- [x] Look into docstring formats and tools for generating documentation
- [x] Set up infrastructure for generating documentation from docstrings: runtimeverification/pyk#811
- [x] Set up infrastruc…
-
### What is the idea?
A lot of the conda modules have no type hinting, incomplete type hinting, no docstrings, or docstrings with varying formats (reST, Google).
### What should happen?
We …
-
When displaying the TexFormat domain in HyperDoc using 'browse" the main terminal displays:
````
(1) -> )hd
(1) -> (HyperDoc) Keyword not currently supported: verb
While parsing T2
(HyperDoc) K…
-
## New feature
Using a DSL/markup in comments in nextflow files to automatically generate docs (HTML, etc.). Allowing to define/describe the inputs/outputs and other information useful for folks wh…
-
### What needs to happen?
See https://github.com/apache/beam/pull/23909#discussion_r1011974873
We use three different formats to represent "type hint" in Python documentation and docstrings. We sh…
-
- Add documentation, initially with docstrings in the sklearn-format.
- Add list of supported input file formats.