-
Reference on python docstrings: https://www.python.org/dev/peps/pep-0257/
All plugin commands should have a doc string with their usage.
-
The following patch changes it so that docstrings are wrapped with the PyDoc_STRVAR macro so that docstrings are stripped if you compile Python with --without-doc-strings. This does not cover "class"…
-
Nowhere in paramnb is the class docstring displayed. In a notebook you can always do e.g. ``Class??`` to see Class's docstring, but it might be nice (particularly when choosing objects in a dropdown) …
-
While the code itself is (partially) documented using JSDoc syntax, our acutal sphinx documentation does not support nor use this. This should be fixed.
-
Quite a few "docstrings" (things that are formatted to look like docstrings for classes, functions, etc.) in the documentation aren't actual docstrings, and their content isn't in the actual codebase.…
-
While autocomplete is working on different IDEs (see tudat-team/tudatpy#22), we could also think of generating our own stub files for tudatpy - we already have the content from the API reference - and…
-
When trying to buld the docs for a package I ran across this error message after running `docs/make.jl`:
```
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doct…
-
We are getting the below errors when building the docs. @Ragzouken you said some docstrings might need fixing?
```
WARNING: Failed to import nanover.ase.omm_calculator.
Possible hints:
* ModuleN…
-
Hi,
I maintain the defopt argument parser generator (https://github.com/anntzer/defopt). I had a quick look at your comparison table in your docs) regarding how defopt compares with the other opti…
-
Consider using module-level, class-level and function-level docstrings for describing the purpose of the module, description of the class or a function (especially when the function name and arguments…