-
Notifications
You must be signed in to change notification settings - Fork 691
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: cabal repl fresh-up #8907
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
^_^d
loads all of the modules of the target into GHCi as interpreted bytecode. | ||
The available | ||
targets are the same as for the ``build`` command: individual components | ||
within packages in the project, including libraries, executables, test-suites |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
“or benchmarks” -> “and benchmarks”?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
doc/cabal-commands.rst
Outdated
The available | ||
targets are the same as for the ``build`` command: individual components | ||
within packages in the project, including libraries, executables, test-suites | ||
or benchmarks. Local packages can also be specified in which case the library |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
“Local packages can also be specified in which case…” maybe semicolon
“Local packages can also be specified; in this case…”
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comma should work, I hope.
doc/cabal-commands.rst
Outdated
Both of these commands do the same thing as the above, but only exposes ``base``, | ||
``vector``, and the ``vector`` package's transitive dependencies even if the user | ||
is in a project context. | ||
To avoid ``ghci`` specific flags from triggering unneeded global rebuilds these |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe comma after “global rebuilds”
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
doc/cabal-commands.rst
Outdated
To avoid ``ghci`` specific flags from triggering unneeded global rebuilds these | ||
flags are stripped from the internal configuration. As a result, | ||
``--ghc-options`` will no longer (reliably) work to pass flags to ``ghci`` (or | ||
other repls). Instead, you should use the ``--repl-options`` flag to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
REPLs for consistency with the chunk below.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
doc/cabal-commands.rst
Outdated
|
||
$ cabal repl --build-depends "vector >= 0.12 && < 0.13" | ||
|
||
Both of these commands do the same thing as the above, but only exposes ``base``, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
exposes -> expose
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whitespace died, but local build of the User's Guide went fine. I forgot, what's the address of the cabal.readthedocs.io build that we could have a look at? Or am I hallucinating there being one?
Guys, you're on top of things. I was about to write some description of what I did here and to provide a link to the built manual, but you jumped on it ahead of me! Context. The text was mostly there already. I just added the intro paragraph from @Mikolaj even if you're hallucinating, you're always right (in my experience anyway). Here's the link: https://cabal--8907.org.readthedocs.build/en/8907/cabal-commands.html#cabal-repl it's under the @ffaf1 thanks! I'll fix it as soon as I get there. Could have been faster if you used GH suggestions 😉 |
90aa8cb
to
ff4a489
Compare
ff4a489
to
4b19ceb
Compare
@mergify backport 3.10 |
✅ Backports have been created
|
4b19ceb
to
387a19e
Compare
docs: cabal repl fresh-up (backport #8907)
@ulysses4ever remember to delete your branches after the merge, or prefix branch names with your nickname like @gbaz does, or use branches from your own fork, so we don't end up with branches we don't know the purpose of and whether to delete them |
@fgaz good point, thank you. There is some setting about auto removal, I thought? Maybe we should just find and turn it on... |
I went ahead and checked the auto-removal box as described here https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-the-automatic-deletion-of-branches |
Didn't do any of the listed below, sorry.
Please include the following checklist in your PR:
Bonus points for added automated tests!