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

New rule: Detect duplicate sections #4

Closed
jfmengels opened this issue Sep 10, 2020 · 0 comments
Closed

New rule: Detect duplicate sections #4

jfmengels opened this issue Sep 10, 2020 · 0 comments
Labels
good first issue Good for newcomers help wanted Extra attention is needed

Comments

@jfmengels
Copy link
Owner

jfmengels commented Sep 10, 2020

What the rule should do:

Report duplicate sections in README and module documentations.

What problems does it solve:

Duplicate sections

Example of things the rule would report:

{-|
# section

# section

## init

@docs init

-}

{-| this is init -}
init = 1

Example of things the rule would not report:

{-|
# section

## Initialization

@docs init

-}

{-| this is init -}
init = 1

When (not) to enable this rule:

If you are working on an application and it has no documentation?

I am looking for:

  • Someone to implement it (I can provide help and guidance)
  • Question: Do you think this should be merged with another rule? If so, which one?
@jfmengels jfmengels added good first issue Good for newcomers help wanted Extra attention is needed labels Sep 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant