Skip to content
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

move whatsnew contributions #3816

Merged
merged 2 commits into from
Sep 7, 2020

Conversation

bjlittle
Copy link
Member

@bjlittle bjlittle commented Sep 5, 2020

This PR tidies some valid whatsnew/contrabutions entries from the legacy and semi-automated mechanism, into the current and manual whatsnew/latest:

These contributions are from older feature branches using the then valid legacy approach to documenting whatsnew entries, which were then merged to master.

@@ -176,6 +187,10 @@ Documentation
* Added a warning to the :func:`iris.analysis.cartography.project` function
regarding its behaviour on projections with non-rectangular boundaries.

* Added an explanation to the user guide of how ``Units`` are handled during
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be useful to have a link to the section of documentation that is added. I assume it would be to this:

https://github.com/SciTools/iris/blob/master/docs/iris/src/userguide/cube_maths.rst#combining-units

Suggest adding a .. _cube-maths_units: anchor and then linking from this whats new entry.

@@ -27,7 +27,9 @@ Features
dependency on `matplotlib`_ at ``v2.x``. Now that ``Python2`` support has
been dropped, ``Iris`` is free to use the latest version of `matplotlib`_.

* `CF Ancillary Data`_ variables are now supported.
* `CF Ancillary Data`_ variables are now supported, and can be loaded from and
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it be useful to link to an issue or pr?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkknight Glad to do that, but for consistency that should also be the case for all other whatsnew entries...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would make the whats new page more useful - we could keep this discussion separate to this PR so we do not block it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tkknight Cool.

For this PR I'll add the relevant links per whatsnew entry mentioned here. Then I'll raise a separate PR to add relevant links to all the other entries, if possible... just to separate concerns. Thanks 👍

@@ -109,6 +115,11 @@ Incompatible Changes
:func:`iris.experimental.concatenate.concatenate` function raised an
exception.

* When loading data from NetCDF-CF files, where a variable has no ``units``
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it be useful to link to an issue or pr?

@tkknight
Copy link
Contributor

tkknight commented Sep 5, 2020

A couple minor comments @bjlittle. I realise this PR is about moving the whats new entries into the new file latest.rst but perhaps the what's news entries could be improved. The documentation one I think should be addressed, the others I am less concerned with but I still think it would benefit links to PRs/Issues if appropriate.

@tkknight tkknight merged commit 62902e2 into SciTools:master Sep 7, 2020
@bjlittle
Copy link
Member Author

bjlittle commented Sep 7, 2020

@tkknight Awesome, thanks 🎉

tkknight added a commit to tkknight/iris that referenced this pull request Sep 7, 2020
…haul

* upstream/master:
  move whatsnew contributions (SciTools#3816)
  Parse with packaging version (SciTools#3815)
  Add "What's New" entries for unpinning Cartopy, Matplotlib, Proj (SciTools#3811)
  tidy issue templates (SciTools#3814)
  Legacy doc notice (SciTools#3813)
  Update issue templates
  Update issue templates
  Update issue templates
  Unpin Matplotlib and proj (SciTools#3762)
tkknight added a commit to tkknight/iris that referenced this pull request Sep 8, 2020
* master:
  Add template collapsible markdown section (SciTools#3823)
  Requirements re-haul (SciTools#3812)
  Automate pull request labels (SciTools#3819)
  move whatsnew contributions (SciTools#3816)
  Parse with packaging version (SciTools#3815)
  Add "What's New" entries for unpinning Cartopy, Matplotlib, Proj (SciTools#3811)
  tidy issue templates (SciTools#3814)
  Legacy doc notice (SciTools#3813)
@stephenworsley stephenworsley mentioned this pull request Sep 8, 2020
5 tasks
@bjlittle bjlittle deleted the combine-legacy-with-new-whatsnew branch September 8, 2020 21:34
tkknight added a commit to tkknight/iris that referenced this pull request Sep 11, 2020
* master: (36 commits)
  Rework whatsnew into new scheme. (SciTools#3834)
  Lazy regridding with Linear, Nearest, and AreaWeighted (SciTools#3701)
  Iris readme minimal (SciTools#3833)
  Fix sphinx logger (SciTools#3832)
  whatsnew entry for dependencies (SciTools#3831)
  Added link to scitools.org.uk on the main index. (SciTools#3830)
  Updated Iris install instructions (SciTools#3817)
  Delete labeler.yml
  Delete label.yml
  Create label.yml
  Delete labeler.yml
  Update labeler.yml
  Update labeler.yml
  Add template collapsible markdown section (SciTools#3823)
  Requirements re-haul (SciTools#3812)
  Automate pull request labels (SciTools#3819)
  move whatsnew contributions (SciTools#3816)
  Parse with packaging version (SciTools#3815)
  Add "What's New" entries for unpinning Cartopy, Matplotlib, Proj (SciTools#3811)
  tidy issue templates (SciTools#3814)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants