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.

Sign up for GitHub

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

Jump to bottom

Add documentation #24

Closed
charleskawczynski opened this issue Dec 15, 2021 · 0 comments
Closed

Add documentation #24

charleskawczynski opened this issue Dec 15, 2021 · 0 comments
Assignees
@yairchn @akshaysridhar
Labels
documentation Improvements or additions to documentation

Comments

@charleskawczynski
Copy link
Member

#19 is a pretty big revamp, and there's several user-facing structs whose fields need documentation.
@charleskawczynski charleskawczynski added the documentation Improvements or additions to documentation label Dec 15, 2021
@akshaysridhar akshaysridhar mentioned this issue Jan 12, 2023
Merged
1 task
bors bot added a commit that referenced this issue Jan 13, 2023
@bors @akshaysridhar
Merge #81
48b25f1 
81: Update documentation r=akshaysridhar a=akshaysridhar

## Purpose 
Update documentation (linked issue #24 )

## Content
- Overview documentation for equations being solved in SurfaceFluxes.jl through application of the Monin-Obukhov Similarity theory. 

<!---
Review checklist

I have:
- followed the codebase contribution guide: https://clima.github.io/ClimateMachine.jl/latest/Contributing/
- followed the style guide: https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/
- followed the documentation policy: https://github.com/CliMA/policies/wiki/Documentation-Policy
- checked that this PR does not duplicate an open PR.

In the Content, I have included 
- relevant unit tests, and integration tests, 
- appropriate docstrings on all functions, structs, and modules, and included relevant documentation.

-->

----
- [x] I have read and checked the items on the review checklist.


Co-authored-by: Akshay Sridhar <asridhar@caltech.edu>
@akshaysridhar akshaysridhar mentioned this issue Jan 13, 2023
Closed
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yairchn yairchn

@akshaysridhar akshaysridhar

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@charleskawczynski @yairchn @akshaysridhar