-
Notifications
You must be signed in to change notification settings - Fork 93
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add "changed in version x.y.z" notes to config descriptions #4342
Comments
Yes please! Was going to raise this on the 8.x timeframe, however, it would be good to mark any configurations which have changed between versions 7 and 8 as "changed in version 8.0.0". |
note to self .. versionchanged:: 1.2.3
Something changed!
|
This looks fairly horrible to do in practice in terms of trawling through the history. I'm going to make a PR for all the changes I can remember making, especially focusing on Cylc 8 changes. IMO the really important places to put these labels are on changes that are being made from now on. I think that it might be easier to pass this issue around everyone whose made changes, because it'll be easier do to your own changes. |
There is also .. versionadded:: 8.0.0 which results in
|
Look at
|
Meeting: move to general doc overhaul (Issue "review CLI and schema and stuff") - go through and do the lot at once. |
(I.E. It would be easiest to do this along with #4091) |
cylc-sphinx-extensions provides prominent versionchanged labels which would be nice to use in the workflow and global config docs, in order to bring attention to changes.
https://cylc.github.io/cylc-sphinx-extensions/extensions/cylc.sphinx_ext.rtd_theme_addons.html#module-cylc.sphinx_ext.rtd_theme_addons
Pull requests welcome!
The text was updated successfully, but these errors were encountered: