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

Improve stratosphere documentation #3114

Merged
merged 6 commits into from
Mar 17, 2023

Conversation

alistairsellar
Copy link
Contributor

@alistairsellar alistairsellar commented Mar 17, 2023

Description

This PR adds the required section "Available recipes and diagnostics" to the Autoassess stratosphere recipe.


Before you get started

Checklist

It is the responsibility of the author to make sure the pull request is ready to review. The icons indicate whether the item will be subject to the 🛠 Technical or 🧪 Scientific review.

New or updated recipe/diagnostic


To help with the number of pull requests:

@alistairsellar alistairsellar self-assigned this Mar 17, 2023
@alistairsellar alistairsellar added this to the v2.8.0 milestone Mar 17, 2023
@alistairsellar
Copy link
Contributor Author

@valeriupredoi or @remi-kazeroni this is part 1 of fixes to close #1775. Would one of you be able to review please?

Copy link
Contributor

@remi-kazeroni remi-kazeroni left a comment

Choose a reason for hiding this comment

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

Thanks for tackling that @alistairsellar! I see that this documentation page somehow follows a different template with different titles for sections. For example model-data instead of variables (but that table looks nicer than the usual list of variables in other pages!) or input and usage instead of user settings in recipe (also nicer in this page, I think). Question: is it planned or possible to rename these sections following what is done for other recipes? But not necessarily reformat the entire sections which look nice here as they are. I leave the rest of the review to @valeriupredoi, don't really have more comments myself.

alistairsellar and others added 3 commits March 17, 2023 14:19
Co-authored-by: Rémi Kazeroni <remi.kazeroni@dlr.de>
Co-authored-by: Rémi Kazeroni <remi.kazeroni@dlr.de>
@alistairsellar
Copy link
Contributor Author

Thanks @remi-kazeroni! Good spot!. I've renamed the section titles, and also re-organise sections to follow what seems to be a more standard order.

Also added ta and ua to the list of ERA-Interim vars.

@valeriupredoi, Remi is leaving the final review to you...

@valeriupredoi
Copy link
Contributor

many thanks @alistairsellar - couple wiggles in the docs build:

/home/docs/checkouts/readthedocs.org/user_builds/esmvaltool/checkouts/3114/doc/sphinx/source/recipes/recipe_autoassess_stratosphere.rst:144: WARNING: Title underline too short.

Observations and reformat scripts
----------------------
/home/docs/checkouts/readthedocs.org/user_builds/esmvaltool/checkouts/3114/doc/sphinx/source/recipes/recipe_autoassess_stratosphere.rst:144: WARNING: Title underline too short.

Observations and reformat scripts
----------------------

Also - we may have to pin sphinx to latest as I have just done in Core - let's see if the tests pass with those two wiggles fixed first 🍺

Co-authored-by: Rémi Kazeroni <remi.kazeroni@dlr.de>
Copy link
Contributor

@remi-kazeroni remi-kazeroni left a comment

Choose a reason for hiding this comment

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

Thanks a lot @alistairsellar! Looks fine to me like this. The documentation page follows the same order as in other pages. All nice and clean 👍 @valeriupredoi you can take a final look and merge whenever you get time for this 🍺

@valeriupredoi
Copy link
Contributor

on it now, gents..

Copy link
Contributor

@valeriupredoi valeriupredoi left a comment

Choose a reason for hiding this comment

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

spick and span, cheers @alistairsellar and Remi for reviewing 🍺

@valeriupredoi valeriupredoi merged commit d7c73bb into main Mar 17, 2023
@valeriupredoi valeriupredoi deleted the improve_stratosphere_documentation branch March 17, 2023 16:16
@alistairsellar
Copy link
Contributor Author

Brilliant - thanks guys!

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.

3 participants