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

In export lists, why indent "section" comments further? #19

Open
jubobs opened this issue Aug 26, 2015 · 0 comments
Open

In export lists, why indent "section" comments further? #19

jubobs opened this issue Aug 26, 2015 · 0 comments

Comments

@jubobs
Copy link
Contributor

jubobs commented Aug 26, 2015

For export lists, you recommend indenting commented "section" lines two spaces further than the opening and closing braces and commas:

Format export lists as follows:

module Data.Set
    (
      -- * The @Set@ type
      Set
    , empty
    , singleton

      -- * Querying
    , member
    ) where

However, you don't seem to follow this recommendation in your own packages (cassava, unordered-containers etc.).

Is this recommendation intentional? If so, are there real benefits to it? Why not simply start the comment in the same column as braces and commas? Like so:

module Data.Set
    (
    -- * The @Set@ type
      Set
    , empty
    , singleton

    -- * Querying
    , member
    ) where
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant