Add a preamble to the tutorial to introduce domain-specific language #2954
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
…-language cloud terminology for ease of reading
cuihtlauac
requested changes
Feb 12, 2025
There was a problem hiding this comment.
Thanks, @jakubsvec001, for your contribution.
I don't think we need to explain in detail what WMO, clouds and their types are. It should be sufficient to have one or two sentences summary. Additionally, that text should be marked as a remark. Including linjks may help.
Etymologic remarks should remain under parentheses.
Comment on lines
22
to
39
| The terms we will be using are: | ||
|
|
||
| - WMO (World Meteorological Organization): | ||
| - a specialized agency of the United Nations (UN) responsible for promoting international cooperation in meteorology, climatology, hydrology, and related geophysical sciences. | ||
| - Cloud: | ||
| - a cloud is a visible mass of tiny liquid water droplets, ice crystals, or both, suspended in the atmosphere. | ||
| - Nimbus: | ||
| - a type of cloud associated with precipitation. | ||
| - Stratonimbus | ||
| - A nimbostratus cloud is a multilevel, amorphous, nearly uniform, and often dark-grey cloud that usually produces continuous rain, snow, or sleet, but no lightning or thunder. | ||
| - Cumulonimbus: | ||
| - a type of cloud that is fluffy and white and produces rain | ||
| - Altocumulus | ||
| - a cumulous cloud at high altitude that does not produce rain | ||
| - Mixtli: | ||
| - the word for *cloud* in Nahuatl (also known as Aztec) | ||
| - Nube: | ||
| - the word for *cloud* in Spanish |
There was a problem hiding this comment.
Summarize this into a one or two block.
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
cuihtlauac
requested changes
Feb 12, 2025
jakubsvec001
commented
Feb 12, 2025
cuihtlauac
requested changes
Feb 13, 2025
|
|
||
| We will be using unique terms for different elements of our project to make the examples clear and unambiguous. For example, if a directory contains a `cloud.ml` file we could name the directory `cloud`, however this may be confusing in our examples below. For example, we will use the Spanish word "nube" and the [Nahuatl](https://en.wikipedia.org/wiki/Nahuatl) word "mixtli", where both terms mean "cloud". | ||
|
|
||
| .. note:: |
There was a problem hiding this comment.
Suggested change
| .. note:: | |
| .. note:: |
Our markdown processor doesn't support this syntax
|
@cuihtlauac Thanks for the heads up on the incorrect markup, I've been writing a lot of .rst markup and it slipped into the .md file. I updated the branch to use the same format used in other ocaml.org lessons ("note:") to denote a remark. |
cuihtlauac
requested changes
Feb 14, 2025
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
cuihtlauac
approved these changes
Feb 14, 2025
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.
I added a preamble to this tutorial to introduce the domain-specific cloud terminology before the dune concepts are explored. The goal is to keep these concerns separate.