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

cabal init not interactive by default in 3.0 #6761

Merged
merged 1 commit into from
May 9, 2020
Merged

cabal init not interactive by default in 3.0 #6761

merged 1 commit into from
May 9, 2020

Conversation

hyperrealgopher
Copy link
Contributor

@hyperrealgopher hyperrealgopher commented May 7, 2020

Since cabal init is no longer interactive by default
(as per my version, 3.0.0.0), including other minor
changes to the init process, change the cabal init
section to mention the usage of the --interactive flag,
and the new minor changes (which/the order questions
are asked, what the terminal output is).

I came across this problem while learning cabal
(having recently migrated from stack) and reading
this section of Cabal's quickstart guide.

Apologies if I have made any mistakes; I am relatively
new to Haskell.


Please include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Any changes that could be relevant to users have been recorded in the changelog (add file to changelog.d directory).
  • The documentation has been updated, if necessary.

Please also shortly describe how you tested your change. Bonus points for added tests!

@phadej phadej requested a review from m-renaud May 7, 2020 05:26
@m-renaud
Copy link
Collaborator

m-renaud commented May 7, 2020

Hey @hyperreal-gopher, thanks for the contribution (and sorry the docs were out of date here)! I had started updating the docs in #6157 should have focused on getting the core differences published first. I just have one request to point to the "Getting Started" guide earlier in the docs for the benefit of future readers.

@m-renaud m-renaud self-assigned this May 7, 2020
@hyperrealgopher
Copy link
Contributor Author

Okay, @m-renaud, all done! I'm glad I could be helpful! I appreciate your guidance with this issue and appreciate your efforts in general.

@m-renaud
Copy link
Collaborator

m-renaud commented May 8, 2020

Just waiting for CI to finish now.

@phadej
Copy link
Collaborator

phadej commented May 8, 2020

Please merge squashed.

@m-renaud
Copy link
Collaborator

m-renaud commented May 8, 2020

@phadej it appears that the "Squash and merge" option from PRs is disabled across the repository. @hyperreal-gopher could you squash the commits on your end and then re-push?

Since `cabal init` is no longer interactive by default
(as per my version, 3.0.0.0), including other minor
changes to the `init` process, change the `cabal init`
section to mention the usage of the `--interactive` flag,
and the new minor changes (which/the order questions
are asked, what the terminal output is).

I came across this problem while learning `cabal`
(having recently migrated from `stack`) and reading
this section of Cabal's quickstart guide.

To be proactive, add TIP relatively-linking to the
new getting started guide
(https://cabal.readthedocs.io/en/latest/getting-started.html)
in a TIP at the top of the page.  Implemented
because that is the best "entrypoint" to the docs,
but many resources/searches still point the user
to this page being modified.
@hyperrealgopher
Copy link
Contributor Author

Okay, I squashed it all to one commit!

@m-renaud m-renaud merged commit a6b6139 into haskell:master May 9, 2020
@m-renaud
Copy link
Collaborator

m-renaud commented May 9, 2020

Thanks again @hyperreal-gopher! Updates are live at https://cabal.readthedocs.io/en/latest/developing-packages.html :)

@hyperrealgopher
Copy link
Contributor Author

That's awesome! I'm so glad I could help! Feels nice making my first contribution to the Haskell community. Thank you, @m-renaud, for walking me through this and reviewing.

@phadej phadej added this to the 3.4.0.0-rc1 milestone Jul 10, 2020
@phadej phadej mentioned this pull request Jul 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants