Coder Social home page Coder Social logo

new sections in documentation about catnip HOT 4 CLOSED

metoffice avatar metoffice commented on July 18, 2024
new sections in documentation

from catnip.

Comments (4)

nhsavage avatar nhsavage commented on July 18, 2024

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

from catnip.

balazagi avatar balazagi commented on July 18, 2024

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

from catnip.

gredmond-mo avatar gredmond-mo commented on July 18, 2024

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

from catnip.

balazagi avatar balazagi commented on July 18, 2024

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

from catnip.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.