Skip to content

ENH: Allow sorting of properties

Florian Spreckelsen requested to merge f-sort-properties into dev

Summary

For https://gitlab.indiscale.com/caosdb/customers/leibniz-zmt/management/-/issues/140. Adds the possibility to configure the order in which the properties of (Records of) a defined RecordType are shown.

Focus

Test Environment

New unit tests should be more or less sufficient. Also test this manually, e.g. by using the demo profile, enabling BUILD_MODULE_EXT_PROPERTY_DISPLAY, and adding the following to your conf/ext/json/ext_prop_display.json:

{
    "MusicalInstrument": {
        "order": ["Photograph", "electric"]
    }
}

Make sure that all properties of all instruments are displayed in the correct order, and that properties that are not part of the order list are appended.

You may also want to verify that the feature does not interfere with the hiding of properties.

Also check whether the new documentation is understandable.

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.

Edited by Timm Fitschen

Merge request reports