Skip to content

Streamline opam package installs and REPL usage#251

Merged
christinerose merged 1 commit intoocaml:mainfrom
yawaramin:patch-1
Jan 31, 2022
Merged

Streamline opam package installs and REPL usage#251
christinerose merged 1 commit intoocaml:mainfrom
yawaramin:patch-1

Conversation

@yawaramin
Copy link
Contributor

Install all opam dev tool packages in one shot, instead of piecemeal. This is
more efficient with the user's time.

Use utop directly instead of spending paragraphs showing the ocaml toplevel,
then talking about rlwrap. For beginners, ocaml toplevel and rlwrap are
almost certainly irrelevant when utop exists.

Install all opam dev tool packages in one shot, instead of piecemeal. This is
more efficient with the user's time.

Use utop directly instead of spending paragraphs showing the `ocaml` toplevel,
then talking about `rlwrap`. For beginners, `ocaml` toplevel and `rlwrap` are
almost certainly irrelevant when utop exists.
@yawaramin
Copy link
Contributor Author

@christinerose thanks for the review. I believe the standard way to refer to the tools is 'opam' and 'utop' (lowercase). This casing is used in the tutorial currently: https://github.com/ocaml/v3.ocaml.org-server/blob/5631257eb3ab0602cfed4b1088d6208e401a5767/data/tutorials/en/000_up_and_running.md

@christinerose
Copy link
Contributor

Thank you for pointing that out @yawaramin. We're in the process of reviewing and updating all documentation, so we'll have a discussion about consistent formatting.

@yawaramin
Copy link
Contributor Author

Thank you. Consistence and standardized formats is a great discussion to have but is that a blocker for this PR? The formatting used here follows the norms of the document as it is currently written. If those change, that can be done in a separate update, no?

@christinerose
Copy link
Contributor

It's not blocking this PR at all. I'll open another one in the future.

@christinerose christinerose merged commit 897d096 into ocaml:main Jan 31, 2022
@yawaramin yawaramin deleted the patch-1 branch January 31, 2022 16:45
yawaramin added a commit to yawaramin/v3.ocaml.org-server that referenced this pull request Apr 29, 2022
Somehow the instructions in this document got mixed up with recent
changes from ocaml#251 . Fix up the
install and toplevel usage instructions.
tmattio pushed a commit that referenced this pull request Apr 29, 2022
Somehow the instructions in this document got mixed up with recent
changes from #251 . Fix up the
install and toplevel usage instructions.
patricoferris pushed a commit to patricoferris/ocaml.org that referenced this pull request Sep 2, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants