DOC: Fix and extend documentation on inheritance
All threads resolved!
All threads resolved!
Compare changes
See #53 (closed). No new code, just docstrings and documentation
Updated/added the docstrings of the add_parent
methods of Entity
, Property
, and RecordType
in caosdb.models
. Also updated the section on inheritance in the data-insertion tutorial. If you are content with the docstrings, we can use the one of Entity.add_parent
as an example for a docstring with a list of **kwargs
, and the one of RecordType.add_parent
as an example for linking to other functions, classes, or methods.
Run make doc
and check the documentation. You may have to delete the _apidocs
directory and re-install this pylib branch beforehand.
Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines
For further good practices have a look at our review guidelines.