Skip to content

Automatic code documentation does not parse argument descriptions

Have a look at:

https://docs.indiscale.com/caosdb-pylib/_apidoc/caosdb.common.models.html#caosdb.common.models.Container.get_property_values

While get_property_values has a description of the parameters, many other functions have none. The way in which the documentation is structured shall be changed that it can be parsed for the auto generated documentation consistently.

Walk through the pylib documentation and check for every function that is used, that

  1. the doc string is structured correctly and that
  2. the documentation of the function is linked (if possible).
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information