DOC: Document the `timeout` option.

Summary

Document the timeout option.

For issue #102 (closed)

Focus

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

assigned to @daniel

changed title from TEST: Failing test for issue 100 to {+DOC: Document the timeout option.+}

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

marked the checklist item All automated tests pass as completed

mentioned in issue #102 (closed)

added 1 commit

• df8c5d5e - DOC: Changelog.

Compare with previous version

marked the checklist item Reference related issues as completed

requested review from @florian

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

marked the checklist item Up-to-date CHANGELOG.md (or not necessary) 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

added 1 commit

• 0d00a3e2 - DOC: Correct Changelog section

Compare with previous version

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

marked the checklist item All automated tests pass as completed

approved this merge request

enabled an automatic merge when the pipeline for 0d00a3e2 succeeds

mentioned in commit b134a587

merged