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

Add and update some docs and doc stubs #925

Merged
merged 1 commit into from
Apr 14, 2022
Merged

Add and update some docs and doc stubs #925

merged 1 commit into from
Apr 14, 2022

Conversation

charleskawczynski
Copy link
Member

This PR:

  • Moves the README table to the developer docs (I wrote this when trying to understand the equations)
  • Moves the index.md contents to a newly added API.md, where we can have/add doc string links
  • Adds Formulation.md, where we can add (perhaps some from the EDMFEquations.md) a story of the EDMF formulation including figures and equations
  • Silences the printed statements in ReferenceStates.md

@charleskawczynski charleskawczynski added the documentation Improvements or additions to documentation label Apr 13, 2022
Copy link
Contributor

@ilopezgp ilopezgp left a comment

Choose a reason for hiding this comment

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

I actually like the prognostic/diagnostic table, I think it is very useful. I would keep it in the README; everything else looks good to me,

@charleskawczynski
Copy link
Member Author

bors r+

@bors
Copy link
Contributor

bors bot commented Apr 14, 2022

Build succeeded:

@bors bors bot merged commit 25f1d8f into main Apr 14, 2022
@bors bors bot deleted the ck/docs branch April 14, 2022 05:45
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.

2 participants