-
Notifications
You must be signed in to change notification settings - Fork 284
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 stash mapping changes v2.0.0 -> v2.1.0 to changelog #3094
Conversation
Hi @tv3141, thanks for making this proposal to increase the detail in the Iris whatsnew. I do, however, have significant reservations about the change in its current form. The Iris whatsnew should detail changes made in Iris, but my concern is that the additions you're proposing here are not changes that have been made in Iris, merely changes that Iris inherits from metarelate and presents to users as Iris behaviour is affected by metarelate changes. By means of an analogy, the change you're proposing here is like reproducing part of the netCDF4-python library's changelist because it impacts on how Iris behaves. Such a reproduction is unprecedented, and "not the done thing", beyond, perhaps, noting that Iris now uses a new version of netCDF4-python by default, which (minus the metarelate release version) is effectively what's happening here too. To preempt a perhaps obvious issue with my argument, I'm aware that a change has been made to Iris in the Having said all that, I very much support the intention here if not the implementation, for the reasons detailed above. I think it's valuable for Iris users to be able to easily see the metadata translation changes that may impact them on release of a new Iris version with metadata translation updates. My proposal for doing this would be a single item in the whatsnew that looks something like the following: ## New Features
* ...
* This release of Iris contains a number of updated metadata translations.
See [this changelist](https://github.com/SciTools/iris/commit/69597eb3d8501ff16ee3d56aef1f7b8f1c2bb316#diff-1680206bdc5cfaa83e14428f5ba0f848) for further information.
* ... So instead of laying out the changes in the whatsnew, we instead provide a link to the changes that have been made to metadata translations (either within Iris or directly from metarelate, I guess). |
@bjlittle This WhatsNew entry is outdated now (since we have just released iris 2.2); is there still value in adding this entry retrospectively? |
replaced list with link of stash mappings
I'm with @dkillick on this : I don't think we should start doing this. Unfortunately I think the key problem is the lack of versioning in https://github.com/metarelate/metOcean. |
We can however just reference #3043, which shows the resulting changes in um_cf_map.py. |
replaced list with link of stash mappings
Boom! Thanks @tv3141, your time and effort is much appreciated. |
Oh yes, that is much nicer ! 💐 |
@tv3141 nice! Thanks for submitting this whatsnew update, and thanks @corinnebosley for the merge 👍 |
Closes #2414.
I included only name changes, as referring to a cube by name is common.
I omitted unit changes and whether a STASH is translated into a standard name or a long_name.