search

haskell / cabal-userguide

A handy user guide for the Cabal build tool
28 stars 5 forks source link

[New Chapter] What is a Module and a Package? #25

Closed JonathanLorimer closed 3 years ago

JonathanLorimer commented 3 years ago

Closes https://github.com/haskell/cabal-userguide/issues/6

I made the decision to do a more thorough treatment of modules to help motivate some of the things Cabal requires (like enumerating exposed modules), and to help the user understand why splitting up a package into its constituent parts is important. The hope is that this will help the reader understand the motivation / intention behind the structure of .cabal files later on. If I got too verbose, or need to trim down the module section I am definitely open to the idea!

JonathanLorimer commented 3 years ago

@Mikolaj Thank you for being so patient with me, for your thorough review, and for your great feedback!

Mikolaj commented 3 years ago

Would somebody else review this version for a change? I may come back much later, but I'm generally satisfied and I don't want to nit-pick too much at this stage, while there may be major improvements that can be made that I don't see.

JonathanLorimer commented 3 years ago

@Mikolaj @emilypi @hsyl20 could I get a final signoff on this (if it sits well with you)?

Mikolaj commented 3 years ago

Could we grant write access to @hsyl20, if only so that his review counts towards mergeability?

@jhrcek: are you satisfied with changes in response to your remarks?

hsyl20 commented 3 years ago

LGTM! Additionally, I've added @hsyl20 as a team member with write access

Ah thanks! I'm not a cabal-install user but I can help with the background info.

emilypi commented 3 years ago

@hsyl20 no worries! Alot of this content is not cabal-specific 😄