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

modules should come with their docs #2

Closed
navidcy opened this issue Sep 13, 2018 · 3 comments
Closed

modules should come with their docs #2

navidcy opened this issue Sep 13, 2018 · 3 comments

Comments

@navidcy
Copy link
Member

navidcy commented Sep 13, 2018

No description provided.

@glwagner
Copy link
Member

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... ?

@navidcy
Copy link
Member Author

navidcy commented Oct 15, 2018

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.

@glwagner
Copy link
Member

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?

@navidcy navidcy closed this as completed Jan 15, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants