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

docs: cabal repl fresh-up #8907

Merged
merged 1 commit into from
Apr 20, 2023
Merged

docs: cabal repl fresh-up #8907

merged 1 commit into from
Apr 20, 2023

Conversation

ulysses4ever
Copy link
Collaborator

@ulysses4ever ulysses4ever commented Apr 17, 2023

Didn't do any of the listed below, sorry.


Please include the following checklist in your PR:

Bonus points for added automated tests!

Copy link
Collaborator

@ffaf1 ffaf1 left a 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
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

“or benchmarks” -> “and benchmarks”?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

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
Copy link
Collaborator

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…”

Copy link
Collaborator Author

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.

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
Copy link
Collaborator

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”

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

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
Copy link
Collaborator

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


$ cabal repl --build-depends "vector >= 0.12 && < 0.13"

Both of these commands do the same thing as the above, but only exposes ``base``,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

exposes -> expose

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Member

@Mikolaj Mikolaj left a 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?

@ulysses4ever
Copy link
Collaborator Author

ulysses4ever commented Apr 17, 2023

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 cabal repl --help (which, I think, is better worded) and examples from there too. Besides, I only added the markup for options (surprisingly, they were in large portion described there already).

@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 Details for docs/readthedocs in the list of CI checks (well, you get to a RTD page where you have to click "View docs"). Whitespace stuff I'll have to look into.

@ffaf1 thanks! I'll fix it as soon as I get there. Could have been faster if you used GH suggestions 😉

@ulysses4ever ulysses4ever force-pushed the docs-cabal-repl branch 4 times, most recently from 90aa8cb to ff4a489 Compare April 17, 2023 23:02
@ulysses4ever ulysses4ever added merge me Tell Mergify Bot to merge and removed attention: needs-review labels Apr 17, 2023
@ulysses4ever
Copy link
Collaborator Author

@mergify backport 3.10

@mergify
Copy link
Contributor

mergify bot commented Apr 18, 2023

backport 3.10

✅ Backports have been created

@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Apr 20, 2023
@mergify mergify bot merged commit 0048326 into master Apr 20, 2023
mergify bot added a commit that referenced this pull request Apr 20, 2023
@fgaz fgaz deleted the docs-cabal-repl branch April 21, 2023 12:16
@fgaz
Copy link
Member

fgaz commented Apr 21, 2023

@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

@ulysses4ever
Copy link
Collaborator Author

@fgaz good point, thank you. There is some setting about auto removal, I thought? Maybe we should just find and turn it on...

@ulysses4ever
Copy link
Collaborator Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge me Tell Mergify Bot to merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants