Skip to content
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

There are two places where the quickstart says it is creating the switch #174

Open
garyrob opened this issue Mar 25, 2023 · 1 comment
Open

Comments

@garyrob
Copy link
Contributor

garyrob commented Mar 25, 2023

After the line, "Do not update project_name.opam manually! Let dune do it for you" there is a heading, "OPAM SWITCH" where it shows the reader how to create a local switch. This section is well-written and does indeed show the reader how to create the local switch.

But then, after that, the following sections appear: "LOCKING DEPENDENCIES", "USING GIT", and "EXPANDING OUR DUMMY APPLICATION". And they are followed by another section called "OPAM SWITCH" which begins, "Next up, we are going to create an opam switch."

This is confusing because we already created the switch several sections earlier. And it's even more confusing because after a brief introductory paragraph, nothing more is said in that section about switches. Instead, it talks about how to use libraries.

I suspect that at some point in the evolution of the quickstart, things were reordered and mixed up and that the second "OPAM SWITCH" heading, and the paragraph that follows it, should have been deleted.

@garyrob
Copy link
Contributor Author

garyrob commented Apr 10, 2023

I created PR 179 to address this.

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

No branches or pull requests

1 participant