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 links to non-existing sections #3

Closed
jfmengels opened this issue Sep 10, 2020 · 1 comment
Closed

New rule: Detect links to non-existing sections #3

jfmengels opened this issue Sep 10, 2020 · 1 comment
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:

Detect links to non-existing sections/functions/types in the documentation, in the README and in the modules.

What problems does it solve:

This would help maintaining documentation (it would notice outdated documentation), and notice when you add a link with an error in the path to the section

I don't think the rule should provide an automatic fix, but I think it could provide suggestions ("Did you mean '#init'?")

Example of things the rule would report:

A [section](#section), if that section does not exist

Example of things the rule would not report:

# section

A [section](#section)

A [section](./ModuleName#section) from another file, if it exists in that file.

Link to image [](./image.png)
{-|
@docs init

Look at the [init](#init) function
-}

{-| the init function -}
init : Model
init = 1

When (not) to enable this rule:

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

I am looking for:

  • A good rule name
  • Someone to implement it (I can provide help and guidance)

(More unorganized thoughts over at https://trello.com/c/BKfdmp8v/2-noinvalidreferences-noinvalidlinks-make-sure-that-all-references-to-sections-are-valid)

@jfmengels jfmengels added good first issue Good for newcomers help wanted Extra attention is needed labels Sep 10, 2020
@lue-bird
Copy link

lue-bird commented Aug 18, 2021

As you suggested: Please yoink lue-bird/elm-review-links-point-to-existing-package-members's rule for the module/definition link part.

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

2 participants