Skip to content

Resolve "Add XML version tags to config file parameter docs"

Lukas Riedel requested to merge 167-add-xml-version-tags-to-config-file-parameter-docs into master

What does this MR do?

Add version information to the XML source files of the default config files. I added the tag versionadded where a new parameter was created and versionchanged if the parameter "location" in the parameter tree was changed. I also added a general note on the parameter file structure in the user docs (adapting these version number occurances is now also mentioned in the GitLab Description Templates).

The version change data is now written into the .rst files with the appropriate Sphinx directives. The data is ordered by decreasing version number, that is, the most recent version is listed first.

Additionally, the write_config wrapper now always throws if an error occurs. Before, it would only throw if the .ini files could not be written.

Is there something that needs to be double checked?

No.

Can this MR be accepted?

  • Added/Updated documentation
  • Pipeline passing
  • Squash option set
  • Delete branch option set
  • Added entry to CHANGELOG.md

Assignee: If the Squash option is set, check/update the commit message right before merging!

Related issues

Closes #167 (closed)

Edited by Lukas Riedel

Merge request reports