Skip to content

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

Description

@jubobs

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions