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

Fix whatsnew api links. #3856

Merged
merged 1 commit into from
Sep 17, 2020
Merged

Conversation

pp-mo
Copy link
Member

@pp-mo pp-mo commented Sep 16, 2020

🚀 Pull Request

Description

A really tiny improvement : I was checking out the new whatsnew format + I noticed that these API refs were subtly wrong + don't function as links.

@trexfeathers
Copy link
Contributor

@pp-mo I think there might be some more too. I'm just going to build some docs from this PR, go through and make a full list...

Copy link
Contributor

@trexfeathers trexfeathers left a comment

Choose a reason for hiding this comment

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

While here, please could you also address:

  • ~iris.Cube.cube.remove_coord on L50
  • L64, where trailing an s after ~iris.coords.CellMeasure appears to have prevented several words rendering

@pp-mo
Copy link
Member Author

pp-mo commented Sep 17, 2020

👍 for diligence.

I followed your suggestions.
I have also improved/corrected a few other formatting problems :

  • changed some 'single backticks' for "code element" formatting (i.e. not external links) to ''double backticks''
    • (NB backticks confuse GitHub markdown, it don't provide a generic escape ?!? boo, hiss 😠 )
  • added some ~ to a description with a lot of long module paths

@pp-mo
Copy link
Member Author

pp-mo commented Sep 17, 2020

Some ideas also occurred to me, to improve the Ancillary Data features entry...
I think this should highlight the new classes and cube access features, as well as describing the netcdf format handling.
(though it already diverts a bit to explain Flags).

But maybe I should just create another PR for that?
I am also wondering whether it would be worth making this into a 'featured change' or 'showcase feature' box,
something like https://scitools-iris.readthedocs.io/en/latest/whatsnew/1.12.html#features

? What do you think @trexfeathers @bjlittle

@trexfeathers
Copy link
Contributor

I think this should highlight the new classes and cube access features, as well as describing the netcdf format handling.

@pp-mo I'm afraid, having not worked on this area of the code at all, I don't have an educated view on the correct amount of detail. This entry was the one merged from the feature branch, so I had assumed that all 3 of you working on it had seen it at the time.


But maybe I should just create another PR for that?

@pp-mo that would be good Git practice I think


I am also wondering whether it would be worth making this into a 'featured change' or 'showcase feature' box,

@pp-mo I was imagining that something of this sort should be written once we're sure nothing else is getting merged. I'm not sure how we decide what goes into it, since none of us have touched all the new features.

@pp-mo
Copy link
Member Author

pp-mo commented Sep 17, 2020

Sorry, a bunch of commits targetting the whatsnew were just merged, causing conflicts here, and it seemed simpler to rebase, so I did.
I think we've more-or-less done with the prior discussion, and it's pretty easy to just re-check the new commits.
If you object, I can try a merge-back approach instead.

@pp-mo
Copy link
Member Author

pp-mo commented Sep 17, 2020

But maybe I should just create another PR for that?

@pp-mo that would be good Git practice I think

See #3865

Review changes, plus extras.
@trexfeathers trexfeathers merged commit 45f23f2 into SciTools:master Sep 17, 2020
tkknight added a commit to tkknight/iris that referenced this pull request Sep 20, 2020
* master:
  Whatsnew for effects on aux factories of units defaulting to 'unknown'. (SciTools#3870)
  Whatsnew entry for SciTools#3867. (SciTools#3868)
  Developer guide overhaul (SciTools#3852)
  Update CF standard name table to v75 (SciTools#3867)
  Link to new classes and methods in the Ancillary variables whatsnew. (SciTools#3865)
  update black version (SciTools#3866)
  Fix whatsnew api links. (SciTools#3856)
  Add additional pre-commit hooks (SciTools#3862)
  update pre-commit flake8 version (SciTools#3863)
  whatsnew - update announcement (SciTools#3861)
  whatsnew - remove contents directive (SciTools#3859)
  whatsnew - links and versions (SciTools#3853)
  Replace deprecated IndexFormatter (SciTools#3857)
  whatsnew for SciTools#3681 (SciTools#3858)
  Whatsnew entry for SciTools#3846. (SciTools#3855)
  Image tests: set agg backend after rcdefaults (SciTools#3846)
  whatnew - announcements (SciTools#3850)
@pp-mo pp-mo deleted the tiny_whatsnew_fix branch March 10, 2021 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants