OCaml Tour: -New sections- Introduction and Before We Begin. Added REPL definition and double semicolon use #2336
+16
−6
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
… and the need for double semicolon
cuihtlauac
requested changes
Apr 12, 2024
There was a problem hiding this comment.
Thanks, @Alfredo-Carlon I think this going in the right direction. Here are suggestions trying to push even further.
Co-authored-by: Cuihtlauac Alvarado <cuihtlauac@users.noreply.github.com>
cuihtlauac
reviewed
Apr 15, 2024
christinerose
approved these changes
Apr 16, 2024
cuihtlauac
requested changes
Apr 19, 2024
cuihtlauac
requested changes
Apr 19, 2024
Remove comments
cuihtlauac
requested changes
Apr 19, 2024
There was a problem hiding this comment.
@Alfredo-Carlon What is your opinion on thoses suggestions?
Comment on lines
+28
to
+31
|
|
||
| To walk through the basics of OCaml by trying out different elements in an interactive manner, we'll use UTop. | ||
| UTop (Universal Toplevel) allows interacting directly with OCaml by reading and evaluating OCaml phrases like expressions or value definitions and printing the result on the screen. | ||
| You can run UTop by using the `utop` command. |
There was a problem hiding this comment.
Suggested change
| To walk through the basics of OCaml by trying out different elements in an interactive manner, we'll use UTop. | |
| UTop (Universal Toplevel) allows interacting directly with OCaml by reading and evaluating OCaml phrases like expressions or value definitions and printing the result on the screen. | |
| You can run UTop by using the `utop` command. | |
| To walk through the basics of OCaml by trying out different elements in an interactive manner, we'll use UTop. You can run UTop by using the `utop` command. Exit it by pressing `Ctrl+D`. | |
| UTop (Universal Toplevel) allows interacting directly with OCaml by reading and evaluating OCaml phrases like expressions or value definitions and printing the result on the screen. |
There was a problem hiding this comment.
@cuihtlauac
Yes we need to mention how to exit UTop :-D
I don't think the shift of sentences helps us.
This is my reasoning:
1st Sentence: Why we'll use something call UTop
2nd Sentence: What is that thing that we will use.
3rd Sentence: How you can start using it.
If we shift the sentences I feel like it breaks a bit the dynamic.
Does this make sense?
Co-authored-by: Cuihtlauac Alvarado <cuihtlauac@users.noreply.github.com>
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.
Resolves #2324
Hi, in this I explicitly mark the Introduction and Prerequisites (Before We Begin) sections. I think it is easier to read, but I'm not sure if the Introduction got shorter :-)
In the prerequisites I also added REPL's definition and on the first example why
;;is required.