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

Error report is not showing line number #3

Open
amimas opened this issue Mar 14, 2019 · 0 comments
Open

Error report is not showing line number #3

amimas opened this issue Mar 14, 2019 · 0 comments
Labels
help wanted Extra attention is needed Type: Feature New Feature

Comments

@amimas
Copy link

amimas commented Mar 14, 2019

I am trying out this rule and really like it so far. It gives me an error report like this:

/Users/amimas/my-project/docs/deploy/index.md
  1:1  error  "URL" is unexpanded acronym. What does "URL" stand for?    unexpanded-acronym
  1:1  error  "CIDR" is unexpanded acronym. What does "CIDR" stand for?  unexpanded-acronym
  1:1  error  "CPU" is unexpanded acronym. What does "CPU" stand for?    unexpanded-acronym
  1:1  error  "JMX" is unexpanded acronym. What does "JMX" stand for?    unexpanded-acronym
  1:1  error  "JVM" is unexpanded acronym. What does "JVM" stand for?    unexpanded-acronym
  1:1  error  "IDE" is unexpanded acronym. What does "IDE" stand for?    unexpanded-acronym
  1:1  error  "DNS" is unexpanded acronym. What does "DNS" stand for?    unexpanded-acronym

The 1:1 is a bit misleading. For other textlint rules this represents the line number where the issue is found but in this rule, it's always 1:1. This can cause confusion too.

I think it's not reporting line number because the acronym can be expanded anywhere in the document, as I understood from the ReadMe of this repo. Ideally an acronym should be expanded the very first time it is introduced in that document. For example, it does not make sense to introduce an acronym at the beginning and explain it later in the document. If we take this approach, then we can probably accurately show a line number in the error report because it will be the first occurrence of the acronym.

@azu azu added Type: Feature New Feature help wanted Extra attention is needed labels Mar 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed Type: Feature New Feature
Projects
None yet
Development

No branches or pull requests

2 participants