F better macro doc

Summary

As a consequence of https://gitlab.com/caosdb/caosdb-crawler/-/issues/20 I added more documentation and more tests.

Test Environment

There are unit tests provided.

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)
• 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)
• 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.

requested review from @florian

assigned to @salexan

marked the checklist item All automated tests pass as completed

marked the checklist item Reference related issues as completed

changed the description

added 12 commits

• 04d65a35...b67e5edb - 11 commits from branch dev
• c6b265d5 - Merge branch 'dev' into f-better-macro-doc

Compare with previous version

added 1 commit

• de02c806 - STY: autopep'd

Compare with previous version

added 1 commit

• 5b388ebd - MAINT: removed print statement

Compare with previous version

resolved all threads

marked the checklist item I understand the intent of this MR as completed

marked the checklist item All automated tests pass as completed

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) as completed

marked the checklist item The test environment setup works and the intended behavior is reproducible in the test as completed

marked the checklist item In-code documentation and comments are up-to-date. as completed

marked the checklist item Check: Are there specifications? Are they satisfied? as completed

mentioned in commit 95a86908

merged