F doc ref properties

Summary

For #150 (closed). Improves (actually, adds) documentation on reference properties.

Focus

Updated data-insertion tutorial and docstring of Entity.add_property

Test Environment

make doc and look at the data-insertion tutorial and the function documentation of Entity.add_property. Can they be understood more easily? Do you miss something?

Check List for the Author

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

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/caosdb/apiutils.py

@@ -43,6 +43,8 @@ from caosdb.common.models import (Container, Entity, File, Property, Query,
                                   get_config, SPECIAL_ATTRIBUTES)
 from caosdb.exceptions import CaosDBException
 
+logger = logging.getLogger(__name__)
+
 
 class EntityMergeConflictError(CaosDBException):
     """An error that is raised in case of an unresolvable conflict when merging
@@ -413,7 +415,7 @@ def merge_entities(entity_a: Entity, entity_b: Entity, merge_references_with_emp
 
     """
 
-    logging.warning(
+    logger.warning(
         "This function is currently experimental and insufficiently tested. Use with care.")
 
     # Compare both entities: