Document replacement of "iris.fileformats.ff" and "iris.experimental.fieldsfile".#2850
Document replacement of "iris.fileformats.ff" and "iris.experimental.fieldsfile".#2850pelson merged 2 commits intoSciTools:masterfrom
Conversation
| Note that there is no direct replacment for | ||
| ```:meth:iris.experimental.fieldsfile.load```, which specifically performed | ||
| fast loading from _either_ PP or FF files. | ||
| Instead, please enable `:meth:iris.fileformats.um.structured_um_loading` and |
There was a problem hiding this comment.
This does not make it clear what the replacement is, it needs to be explained in more detail, an example may be useful.
There was a problem hiding this comment.
I guess this will cross reference the docs at http://scitools.org.uk/iris/docs/latest/iris/iris/fileformats/um.html#iris.fileformats.um.structured_um_loading
There was a problem hiding this comment.
this will cross reference the docs at ... iris.fileformats.um.structured_um_loading
Yes, I thought that would be good enough : as it's only a whatsnew item, I think it can be a pointer rather than full info, no ?
|
@ajdawson - I merged this based on the responses to your review comment. I'm totally happy to improve the wording of the what's new wherever we can. Given the xrefs, would you still like to see the example added / some more detail? We can definitely action some more work on this if so. 👍 |
|
It would be clearer if you just said it was a context manager in the what's new, it avoids clicking a link just to find that out. |
|
Re-reading, I must agree it's still not terribly clear. |
3 participants
Closes #2818.