cabal-userguide icon indicating copy to clipboard operation
cabal-userguide copied to clipboard

Ch-01 What do we mean when we say cabal?

Open srirajshukla opened this issue 4 years ago • 17 comments

This chapter contains the different meanings of the term cabal.

Right now, I've just added the basic skeleton. I'll be adding more information about the topic.

srirajshukla avatar Jul 21 '21 19:07 srirajshukla

@JonathanLorimer Sorry for being so late on this! I got caught up with some other work. I've started working on it and took some inspiration from your article.

Is the structure that I'm following right now okay or should I make some changes?

srirajshukla avatar Jul 21 '21 19:07 srirajshukla

@srirajshukla Hey, thanks for taking this up, and no worries life happens. The structure looks fine for now, I will probably have more to say as you write the sections out.

JonathanLorimer avatar Jul 21 '21 19:07 JonathanLorimer

Hi @JonathanLorimer, when I am trying to make a commit, I'm getting the error that custom prettier failed even though I've formatted the file with prettier and manually checked with it as well.

bash-4.4$ prettier -c "src/preamble/01_what_do_we_mean_when_we_say_cabal.md"
Checking formatting...
All matched files use Prettier code style!
bash-4.4$ git commit -m "Added details about cabal-install, CABAL, .cabal"
[WARNING] Unstaged files detected.
[INFO] Stashing unstaged files to /home/sok/.cache/pre-commit/patch1628022078.
Custom Prettier..........................................................Failed
- hook id: custom-prettier
- files were modified by this hook

src/preamble/01_what_do_we_mean_when_we_say_cabal.md

nixpkgs-fmt..........................................(no files to check)Skipped
[WARNING] Stashed changes conflicted with hook auto-fixes... Rolling back fixes...
[INFO] Restored changes from /home/sok/.cache/pre-commit/patch1628022078.

srirajshukla avatar Aug 03 '21 20:08 srirajshukla

Perhaps do git add various_files before git commit or do git commit -a -m "foo"?

Mikolaj avatar Aug 03 '21 20:08 Mikolaj

I got it working, the pre-commit hook was suggesting a change. I wasn't staging it. 😅

srirajshukla avatar Aug 03 '21 20:08 srirajshukla

@srirajshukla Glad you got it figured out. Sorry for the friction, it can sometimes be a contentious issue whether pre-commit hooks should automatically stage changes or not. Also sorry for the radio silence, I was on vacation. I will have a look at this PR today!

JonathanLorimer avatar Aug 06 '21 16:08 JonathanLorimer

1628270332_grim 1628270340_grim Just posting some screenshots of running the build locally to demonstrate that things look as though they are styled correctly!

JonathanLorimer avatar Aug 06 '21 17:08 JonathanLorimer

@JonathanLorimer Hope you had a great vacation! Yeah, about the pre-commit hook thing, can we add it somewhere (maybe in contributing.md or someplace like that).

I think I am missing a few references and links, so I'll add them too. And maybe a bit more in the cabal library section.

srirajshukla avatar Aug 06 '21 18:08 srirajshukla

@JonathanLorimer

srirajshukla avatar Aug 09 '21 19:08 srirajshukla

@srirajshukla Thanks for getting these changes in so quickly! I will give this a review tonight.

JonathanLorimer avatar Aug 09 '21 19:08 JonathanLorimer

@JonathanLorimer I was sick for a few days so I didn't do it earlier. I've made the changes.

srirajshukla avatar Aug 16 '21 18:08 srirajshukla

Hi @JonathanLorimer , please review it when you've got some time

srirajshukla avatar Sep 02 '21 17:09 srirajshukla

@JonathanLorimer I hope it is fine now. 😅

srirajshukla avatar Sep 08 '21 19:09 srirajshukla

@Mikolaj can you give this a review?

JonathanLorimer avatar Sep 09 '21 13:09 JonathanLorimer

@Mikolaj can you give this a review?

Not right now, but yes, with pleasure.

Mikolaj avatar Sep 09 '21 14:09 Mikolaj

I apologise for the delay in reviewing --- we've just had regressions discovered in the published 3.6 and also CI got completely broken by changes in GitHub Actions. We are still saving the world, but I will review later, unless somebody else does and unblocks you.

Mikolaj avatar Sep 18 '21 21:09 Mikolaj

OK, I'm back, will review RSN. :)

Mikolaj avatar Sep 27 '21 14:09 Mikolaj