-
Notifications
You must be signed in to change notification settings - Fork 697
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
Added or expanded 5 comments… #9340
Conversation
ab51769
to
8ba1b71
Compare
I know the implicit issue, i.e, some maintainers have e-mail alerts set to any attempt at PR, and I just spammed multiple people's inboxes, and I'm really sorry about that. make style is apparently going berserk, but I'm not going to ask for people's time when I can't even get my fourmolu working on VSC (It's apparently either ignoring the fourmolu.yaml or just diverting to a different piece of software). Hope that something at least useful comes out of this PR. |
Contributions are always appreciated, helping each other is paramount!
|
Commit message should be formatted to standard way, as per
will do. |
What would you recommend as a path of action, then? Step 1. Edit the commit message to match requirements; i.e, split the subject line with a summary, Step 2. Expand some of the comments to match line width expectations for comments. Step 3. Be clearer on what a splitter is, or rather, remove the term entirely. Instead, Step 4. I am personally dissatisfied with one comment (mainHelper), as I don't think it's clear enough |
For sure, @liamzee! |
58a9ab9
to
8ba1b71
Compare
cd11bb7
to
6cfeac4
Compare
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.
Very good!
Add a |
To help make the Cabal codebase more accessible, expandResponse in Cabal/Distribution.ResponseFile received Haddock documentation. The defaultMainHelper function in Cabal/Distribution.Simple received hidden Haddock documentation. In the hidden module cabal-install/Distribution.Client.Main, the Haddock documentation for main was expanded, additional commenting explaining the response file compatibility code in main was added, and documentation for mainWorker was added.
6cfeac4
to
46369b2
Compare
…I documented lightly defaultMainHelper in Cabal/Distribution.Simple, expandResponse in Cabal/Distribution.Compat.ResponseFile, expanding the main comment in cabal-install/Distribution.Client.Main, adding segmentation commenting marking responseFiles handling in cabal-install/Distribution.Client.Main (main), added haddock documentation to mainWorker in cabal-install/Distribution.Client.Main .