search

MetOffice / CATNIP

Climate Analysis Tool: Now In Python
Other
5 stars 2 forks source link

new sections in documentation #4

Closed zmaalick closed 4 years ago

zmaalick commented 4 years ago

Write new "how to" sections

nhsavage commented 4 years ago

remove references to FCM, add information on how to add doctests and sample data and update document after making changes to the code

Two types of "how to" a. User guide - how to install and test a local copy of CATNIP b. Developer guide - how to make changes to CATNIP. Partly there, needs updating. Adding extra e..g how to do a docstring, how to update docs

Split into 2 issues

balazagi commented 4 years ago

remove references to FCM, add information on how to add doctests and sample data and update document after making changes to the code

Two types of "how to" a. User guide - how to install and test a local copy of CATNIP b. Developer guide - how to make changes to CATNIP. Partly there, needs updating. Adding extra e..g how to do a docstring, how to update docs

Split into 2 issues

please note that quiet a bit of what this issue is trying to achieve has been addressed in issue #16 so perhaps better to make any new issues after reviewing the pull request #21

gredmond-mo commented 4 years ago

ok, I'll hold off doing anything else until #21 has been reviewed and resolved.

balazagi commented 4 years ago

I think that pull request 31 now merged into the develop branch, has addressed most of what this issue had aimed for. In my opinion the only thing is left is the "how install and test a local copy of CATNIP" which think can be two separate issues and done after we have completed issues: #6, #27 and #28. If you agree please close this and open new issues