-
Notifications
You must be signed in to change notification settings - Fork 291
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
(Docs) Shorten Introduction on "Tour of OCaml" and Mention Double Semicolon #2324
Comments
How much do you think it should be shortened? |
I don't believe length is such a big issue.
|
Hi, I think I can write a proposal about I think that compared to the other tours, this one is on the right track but there is room for improvement, e.g. stating the goal of the Tour on the first paragraph, etc. |
Thanks @kephas and @Alfredo-Carlon. There's always room for improvement; anybody is always welcome to make shortening or clarifying contributions. Please do. There may have been a misunderstanding. I was referring to “Tour of OCaml” overall length whilst @sabine seems to have been referring to its introduction paragraph, and @Alfredo-Carlon seem to be referring to its conclusion paragraph. To be fair, the OCaml full tour is “Tour of OCaml” + “Your First OCaml Program” which is 762 + 410 = 1172. In all cases, we're happy to read any proposal from anybody. |
Yes, there's no problem with the length of the document in its entirety. I am only talking about the introduction at the very top of the document. It is longer than necessary and repetitive on mentioning the REPL but it does not address the three points that user testing has identified to be missing. ETA: Indeed, editing on the documentation to help improve clarity is always welcome and we are happy to review such PRs! ✨ |
Super @cuihtlauac and @sabine A pull request is up for just the Introduction, REPL and |
The introduction on https://ocaml.org/docs/tour-of-ocaml needs to
;;
needs to be used.The corresponding document is https://github.com/ocaml/ocaml.org/blob/main/data/tutorials/getting-started/1_01_a_tour_of_ocaml.md
The text was updated successfully, but these errors were encountered: