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 documentation and make doc strings clearer for compass/landice/mesh.py #571

Open
hollyhan opened this issue Mar 21, 2023 · 3 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation land ice

Comments

@hollyhan
Copy link
Contributor

The developers guide on the landice framework module compass/landice/mesh.py is currently missing documentation, which needs to be added.

Also, some of the doc strings in the code can be made more clear,
e.g., doc string for the argument section in the function get_dist_to_edge_and_GL

@hollyhan hollyhan added documentation Improvements or additions to documentation land ice labels Mar 21, 2023
@trhille
Copy link
Collaborator

trhille commented Mar 21, 2023

Thanks for flagging this, @hollyhan. I'll try to get to this soon.

@xylar
Copy link
Collaborator

xylar commented Mar 21, 2023

@trhille, I'll add that @hollyhan and I were looking for details on which config options are needed from the provided section and how these values are used.

@trhille
Copy link
Collaborator

trhille commented Mar 21, 2023

Okay, thanks. I'll make sure those are more clearly communicated.

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 land ice
Projects
None yet
Development

No branches or pull requests

3 participants