Skip to content

Adding a dumpload of documentation#113

Merged
mattiarighi merged 52 commits into
developmentfrom
development_VsDocumentationMegaBranchBOOM
Aug 2, 2019
Merged

Adding a dumpload of documentation#113
mattiarighi merged 52 commits into
developmentfrom
development_VsDocumentationMegaBranchBOOM

Conversation

@valeriupredoi

@valeriupredoi valeriupredoi commented Jun 25, 2019

Copy link
Copy Markdown
Contributor

sister PR to ESMValGroup/ESMValTool#1172

Documentation split (#89) should be completed before this can be merged.

@valeriupredoi valeriupredoi added the documentation Improvements or additions to documentation label Jun 25, 2019
Comment thread doc/sphinx/source/esmvalcore/preprocessor.inc Outdated
Comment thread doc/sphinx/source/esmvalcore/preprocessor.inc Outdated
Comment thread doc/sphinx/source/esmvalcore/preprocessor.inc Outdated
@valeriupredoi

valeriupredoi commented Jun 25, 2019

Copy link
Copy Markdown
Contributor Author

@mattiarighi @bouweandela @ledm as a word of plz plz do this: in documentation function and parameter and units and error names use verbatim and use Iris (capitalized) since they use Iris on their readthedocs. Cheers! That will make things much easier 🍺

@valeriupredoi

Copy link
Copy Markdown
Contributor Author

also here's how I'll do stuffs: I am writing furiously like a proper reporter from Rolling Stone and I will post here when I'm done with different modules (eg tomorrow I'll be done with preprocessor.inc and I'll post I'm done). In the meantime pls pls no change requests or suggestions for the WIP module. When I'm done with each module then I'll shout it and leave it and it's all yours for changing it 🍺

@mattiarighi

Copy link
Copy Markdown
Contributor

Can you put this in draft mode?
So you can let us know when it's ready for review.

@valeriupredoi

Copy link
Copy Markdown
Contributor Author

Can you put this in draft mode?
So you can let us know when it's ready for review.

@mattiarighi I believe it is easier for you guys to review each module when I call it done (on my side) than reviewing the whole shebang because that's gonna be a lot to go through if not doing it module by module 🍺

@valeriupredoi

Copy link
Copy Markdown
Contributor Author

OK preprocessor.inc is done from my side: @jvegasbsc could you pls input the stuff under CMORization and dataset-specific fixes 🍺 Also, the others, lease feel free to edit preprocessor.inc, I'll always pull regularily so there's no conflicts (pls don't prompt me to change things since I'm moving on to _data_finder now) 📚

@valeriupredoi

Copy link
Copy Markdown
Contributor Author

OK datafinder.inc is done from my side

@BenMGeo BenMGeo left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I like the text you propose here. It's easy to find in the masking section.

You might comment out the time_window as it falls back to default then?
Maybe even the min_value, if you set the default to -inf.

Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/recipe.rst
Comment thread doc/esmvalcore/recipe.rst
Comment thread doc/esmvalcore/recipe.rst Outdated
@mattiarighi mattiarighi requested review from BenMGeo and mattiarighi and removed request for BenMGeo July 31, 2019 07:17
Comment thread doc/esmvalcore/recipe.rst
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/preprocessor.rst Outdated
Comment thread doc/esmvalcore/config.rst Outdated
Comment thread doc/esmvalcore/datafinder.rst Outdated
mattiarighi and others added 5 commits August 2, 2019 11:13
Co-Authored-By: Lee de Mora <ledm@pml.ac.uk>
Co-Authored-By: Lee de Mora <ledm@pml.ac.uk>
Co-Authored-By: Lee de Mora <ledm@pml.ac.uk>
@mattiarighi

Copy link
Copy Markdown
Contributor

Thanks for reviewing. Your suggestions have been implemented.

@mattiarighi mattiarighi merged commit 32dbea3 into development Aug 2, 2019
@mattiarighi mattiarighi deleted the development_VsDocumentationMegaBranchBOOM branch August 2, 2019 10:06
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.

5 participants