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

Tweaks to documentation for v2.0 release #2897

Closed
6 tasks done
pp-mo opened this issue Oct 31, 2017 · 2 comments
Closed
6 tasks done

Tweaks to documentation for v2.0 release #2897

pp-mo opened this issue Oct 31, 2017 · 2 comments

Comments

@pp-mo
Copy link
Member

pp-mo commented Oct 31, 2017

A quick rundown of some problems I noticed checking through the current whatsnew + it's links ...

  • the "Dask processing options" notes at the bottom of the "Real and Lazy Data" userguide section are out-of date -- possibly can be removed altogether (see also: Update dask userguide section of documentation re: default dask engine #2882)
  • likewise, where in the initial whatsnew para talks about Dask schedulers, that is probably now obsolete.
  • a few items in the whatsnew "Deprecation removals" section really belong elsewhere :
    • "iris.fileformats.pp_rules has been renamed ..." --> in "Incompatible Changes" ?
    • "When saving a cube or list of cubes in NetCDF format ..." --> in "Incompatible Changes" ?
    • "If the packing argument to iris.save is a dictionary ..." --> enhancement or bugfix ?
  • we are still missing a whatsnew entry regarding changes to BMDI setting in saved PP data -- see this comment for some suggested text
@pp-mo pp-mo added this to the v2.0.0 milestone Oct 31, 2017
@DPeterK
Copy link
Member

DPeterK commented Oct 31, 2017

where ... the initial whatsnew para talks about Dask schedulers

Having just read this section I think I'd prefer it if that paragraph was left in place. The statements remain true and accurate, and changing dask processing options will still affect how Iris works, it's just Iris no longer affects dask processing options at all. The paragraph might be improved by including a link to the dask docs on processing options though (this could be lifted directly from the section in the user guide that we probably no longer need).

@DPeterK
Copy link
Member

DPeterK commented Nov 3, 2017

Completed in #2900 and #2903.

@DPeterK DPeterK closed this as completed Nov 3, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants