Skip to content
Snippets Groups Projects

Some small changes to the YAML documentation.

Merged Daniel Hornung requested to merge f-yaml-doc into dev
3 unresolved threads

Summary

Some small changes to the YAML documentation.

Focus

Is the documentation better now?

Test Environment

make doc

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 -> caosdb/customers/aba/management#15
  • 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.

Edited by Florian Spreckelsen

Merge request reports

Loading
Loading

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
13 13
14 14 Getting started <README_SETUP>
15 15 Concepts <concepts>
16 tutorials
  • 1 YAML-Interface
    2 --------------
    3 1
    4 The yaml interface is a module in caosdb-pylib that can be used to create and update
    2 ===============================
    3 YAML data model specification
    4 ===============================
    5
    6 The ``caosadvancedtools`` library features the possibility to create and update
  • 1 YAML-Interface
    2 --------------
    3 1
    4 The yaml interface is a module in caosdb-pylib that can be used to create and update
    2 ===============================
  • Daniel Hornung marked the checklist item Annotations in code (Gitlab comments) as completed

    marked the checklist item Annotations in code (Gitlab comments) as completed

  • Daniel Hornung requested review from @florian

    requested review from @florian

  • Daniel Hornung marked the checklist item All automated tests pass as completed

    marked the checklist item All automated tests pass as completed

  • Daniel Hornung added 1 commit

    added 1 commit

    Compare with previous version

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

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

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

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

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

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

  • Florian Spreckelsen approved this merge request

    approved this merge request

  • Florian Spreckelsen enabled an automatic merge when the pipeline for d49d3023 succeeds

    enabled an automatic merge when the pipeline for d49d3023 succeeds

  • mentioned in commit 28cfc66e

  • Please register or sign in to reply
    Loading