Add clarifying language to docs index page #93
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Mar 6, 2024
|
(PS I fixed the pre-commit hook in another PR so no need to worry that the action is failing) |
Co-authored-by: Romain Caneill <[email protected]>
paigem
commented
Mar 7, 2024
|
Thanks @rcaneill for your input here! I don't think I have the ability to merge, so I'll let you do the honors when you're ready. |
paigem
commented
Mar 7, 2024
rcaneill
approved these changes
Mar 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In general, I think the documentation of this package could be made a bit clearer. I make a few suggestions in this PR, particularly around the language used to describe the 3 examples. However, I haven't used NEMO data myself, so please review the wording I used and ensure that it is correct.
My main issue with this docs index page is that it assumes a high level of NEMO knowledge. I understand that most people who use this tool will be well-versed in the output files and structures of NEMO, but with just a little effort, these docs can also be helpful for people who are new to using NEMO.
For example, I don't actually know why it's important to "recombine" the domain_cfg and mesh_mask files (Example 2). I took a stab at explaining why this is necessary in this PR, but just a sentence motivating why this is useful for users would be very helpful.