Init CLI flag documentation improvement

[emilypi]

See @Mikolaj's comment. The existing docs are there for anyone who issues --help, but it's non-obvious to Haskell developers that they may need help, so this creates a natural conflict.

[ulysses4ever]

I think shoving more stuff in the --help isn't very helpful (although isn't harmful either, so I approve). My impression from that issue thread was that the agreement was that it's the interactive mode who should advertislze the other mode in the very beginning.

cc @AndreasPK

[geekosaur]

I'm neutral on this, FWIW, and agree that we should consider splitting functionality at some point as something more useful than just adjusting help text.

I will note that some programs (notably most of Larry Wall's: original patch, rn, etc.) output their manpages for --help. (But not Perl, because it's a full language and there's like 30 of them at this point and were at least 10 at the original public release.) That's probably overkill, though.

[emilypi]

At the very least, the documentation was stale, so this brings it up to par before we branch off or do whatever.

[ulysses4ever]

Emily, I should have said first that I appreciate your effort before jumping into the negative part. I apologize!

I didn't notice any fixes per se: I thought this patch was purely additive. But I see it now: the part about supplying the root of the project was removed. Thanks!

But since you mentioned documentation, I think these days (and especially due to the AI storm) the online docs are much more important than --help. In general, when updating one, I'd expect an update to the other as well... I have checked https://cabal.readthedocs.io/en/stable/cabal-commands.html#cabal-init now and, sure enough, it looks outdated as well because it appears to be implying the noninteractive default.

[emilypi]

I actually don't know how to modify the readthedocs site fwiw - point me at the repo and I'm sure I'll survive. I can add it to the PR. I don't mind criticism btw - we're in subjective territory here

[ulysses4ever]

right here: https://github.com/haskell/cabal/blob/master/doc/cabal-commands.rst#cabal-init

[emilypi]

@ulysses4ever thanks! updated.

[ulysses4ever]

Great! The formatting and whitespace jobs are failing which is the last thing that needs fixing before the merge bot can take it.