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

Suggested Documentation changes #690

Merged

Conversation

ssmithClimate
Copy link
Contributor

@ssmithClimate ssmithClimate commented Jun 30, 2020

A few documentation suggestions, mentioned in:
Issue #1684

Closes ESMValGroup/ESMValTool#1684

@ssmithClimate ssmithClimate changed the title Documentation changes Suggested Documentation changes Jun 30, 2020
doc/recipe/overview.rst Outdated Show resolved Hide resolved
Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

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

Thank you for helping to improve the documentation! In case you missed it, you can preview what the changed documentation looks like by building the documentation locally. We're working on getting a preview available on-line too, but that doesn't work yet unfortunately.

@mattiarighi mattiarighi added the documentation Improvements or additions to documentation label Jul 9, 2020
ssmithClimate and others added 3 commits July 10, 2020 09:31
@ssmithClimate
Copy link
Contributor Author

@bouweandela I believe all comments above are implemented and text is consistent now from what I can tell.

Copy link
Member

@bouweandela bouweandela left a comment

Choose a reason for hiding this comment

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

Thanks!

@bouweandela bouweandela merged commit aaadc73 into ESMValGroup:master Jul 10, 2020
@ssmithClimate ssmithClimate deleted the documentation_suggestions branch July 10, 2020 14:59
mattiarighi pushed a commit that referenced this pull request Jul 13, 2020
* Remove utils section (#697)

Moved the last script from esmvalcore/utils to ESMValTool

* Fixed bug in time weights calculation (#695)

* Fixed calculation of time weights

* Fixed failing FLAKE8 test

* Added more test for time weighting and fixed cube dimensions in test

* Avoid pytest version that crashes (#707)

* Suggested Documentation changes (#690)

Update documentation on relative diagnostics paths and preprocessor order.

Co-authored-by: Bouwe Andela <[email protected]>

* Options arg in read_config_user_file now optional

* Fix codacy warning

Co-authored-by: Bouwe Andela <[email protected]>
Co-authored-by: Manuel Schlund <[email protected]>
Co-authored-by: Steve Smith <[email protected]>
Co-authored-by: Bouwe Andela <[email protected]>
jvegreg pushed a commit that referenced this pull request Jul 16, 2020
* Remove utils section (#697)

Moved the last script from esmvalcore/utils to ESMValTool

* Fixed bug in time weights calculation (#695)

* Fixed calculation of time weights

* Fixed failing FLAKE8 test

* Added more test for time weighting and fixed cube dimensions in test

* Avoid pytest version that crashes (#707)

* Suggested Documentation changes (#690)

Update documentation on relative diagnostics paths and preprocessor order.

Co-authored-by: Bouwe Andela <[email protected]>

* Options arg in read_config_user_file now optional

* Fix codacy warning

Co-authored-by: Bouwe Andela <[email protected]>
Co-authored-by: Manuel Schlund <[email protected]>
Co-authored-by: Steve Smith <[email protected]>
Co-authored-by: Bouwe Andela <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Preprocessor documentation clarification
3 participants