-
Our docstrings currently use a variety of formats and we should agree a standard.
My suggestion is that we use Numpydoc (https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt) since i…
-
Consider the "colorful" style and how it formats `String.Doc`. [According to the code](https://github.com/pygments/pygments/blob/3e1b79c82d2df318f63f24984d875fd2a3400808/pygments/styles/colorful.py#L…
-
Background/Disclaimer: [PEP 727](https://peps.python.org/pep-0727/) is still in draft after more than a year; from the [discussion](https://discuss.python.org/t/pep-727-documentation-metadata-in-typin…
emcd updated
2 months ago
-
It looks like some of the formatting of the docstrings in tf v2 don't quite match the formats used in keras which results in ugly rendering:
![DeepinScreenshot_select-area_20201028143327](https://u…
-
### Feature and motivation
Right now across the code base there are docstrings in different formats. A mix of:
`Google` style, i.e:
```python
"""
This is an example of Google style.
Arg…
-
These workflows need updating. May also be a good opportunity to add targeted unit tests for different input file formats (NIfTI, CIFTI, TSV) and docstrings.
### Resampling to the surface
- [x] …
-
**Is your feature request related to a problem? Please describe.**
Due to incorrectly formatted docstrings, some Python reference docs that intend to cross-reference the Python documentation show up …
-
"_As a Bodywork Developer, I would like all docstrings to be in the Google format, so that they are easier to read._"
**Tasks**
- Investigate [pyment](https://github.com/dadadel/pyment) and [docco…
-
### Discussed in https://github.com/MetPX/sarracenia/discussions/502
Originally posted by **reidsunderland** April 8, 2022
Since Sphinx has been setup, we can use docstrings to document the c…
-
# Develop Lesson Plan Generator Tool
## Description
As an **educator**, I want to generate detailed lesson plans tailored to a specific grade level and topic so that I can effectively deliver st…