Skip to content

F doc page length

Florian Spreckelsen requested to merge f-doc-page-length into main

Summary

For #172 (closed). See also community channel. Since I was explaining the page_length parameter anyway, I wrote a short example for the documentation.

Focus

Only new docs. Is it understandable? Do all links point to the correct targets?

Test Environment

make doc
firefox build/doc/html/tutorials/paginated_queries.html

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 The integration tests fail since this f-branch bases on main but triggers them in dev, so they don't know about the new role keyword off get_entity_by_id. Unrelated to this MR.
  • 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.

Edited by Alexander Schlemmer

Merge request reports

Loading