Coder Social home page Coder Social logo

Comments (3)

glwagner avatar glwagner commented on June 12, 2024

Agree in principle, but there is precedent for the "develop first, document later" strategy...

I think a natural workflow is to develop a code, start using it for research, and then as things are running and in a stable place start to update the docs. In early phases when we are still trying to decide what things are called (is it energy00 or Uenergy?) it saves time to put off doc-writing.

Also, putting off doc-writing gives us the chance to return to the code and look over it a second time... ?

from geophysicalflows.jl.

navidcy avatar navidcy commented on June 12, 2024

There is some miscommunication here.
What I meant is when we move modules from FourierFlows.jl here then we should move their modest documentation from FourierFlows.jl.

Other than that I totally agree.

from geophysicalflows.jl.

glwagner avatar glwagner commented on June 12, 2024

As far as I can tell, the module documentation was ported from FourierFlows to GeophysicalFlows.

For example, here is the TwoDTurb documentation.

What am I missing?

from geophysicalflows.jl.

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.