diff --git a/src/caosdb/common/models.py b/src/caosdb/common/models.py index 974c52613f6252ac9ef550f64077cb774e4917b1..20e09810ba466d59cf7a82d68cad19fefb45b10b 100644 --- a/src/caosdb/common/models.py +++ b/src/caosdb/common/models.py @@ -647,11 +647,13 @@ class Entity: entity. If no `inheritance` is given, no properties will be inherited by the child. This parameter is case-insensitive. - Note that the behaviour is currently not yet specified when assigning parents to - Records, it only works for inheritance of RecordTypes (and Properties). - - For more information, it is recommended to look into the - :ref:`data insertion tutorial<tutorial-inheritance-properties>`. + Notes + ----- + Note that the behaviour of the `inheritance` argument currently has not + yet been specified when assigning parents to Records, it only works for + inheritance of RecordTypes (and Properties). For more information, it is + recommended to look into the :ref:`data insertion + tutorial<tutorial-inheritance-properties>`. Raises ------ @@ -1344,12 +1346,19 @@ out: List[Entity] anyway. Set the flag 'strict' to True in order to force the server to take all warnings as errors. This prevents the server from inserting this entity if any warning occurs. - @param strict=False: Flag for strict mode. - @param raise_exception_on_error=True: Flag to raise an - exception when an error occurs. - @param unique=True: Flag to only allow - insertion of elements with unique names. - @param flags: A dictionary of flags to be send with the insertion. + Parameters + ---------- + strict : bool, optional + Flag for strict mode. Default is False. + raise_exception_on_error : bool, optional + Flag to raise an exception when an error occurs. Default is True. + unique : bool, optional + Flag to only allow insertion of elements with unique names. Default + is True. + flags : dict, optional + A dictionary of flags to be send with the insertion. Default is + None. + """ return Container().append(self).insert(