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

Acronyms involving hyphen or "X" is not recognized properly #4

Open
amimas opened this issue Mar 15, 2019 · 2 comments
Open

Acronyms involving hyphen or "X" is not recognized properly #4

amimas opened this issue Mar 15, 2019 · 2 comments
Labels
Type: Bug Bug or Bug fixes Type: Feature New Feature

Comments

@amimas
Copy link

amimas commented Mar 15, 2019

There are certain acronyms that is expanded slightly differently. For example:

  • CIDR is expanded as "Classless Inter-Domain Routing"
  • JMX is expanded as "Java Management Extension"

In these cases, even though the acronyms have been expanded, the rule does not recognize it because the expansion pattern is slightly different. For the first example, there's a hyphen (-) and for the second example, the last letter of the acronym does not start with the same letter when expanded.

@amimas
Copy link
Author

amimas commented Mar 19, 2019

Found one more scenario where this rule does not work. For example: it does not work if the acronym expanded contains another acronym.

  • 1:1 error "JWT" is unexpanded acronym. What does "JWT" stand for? unexpanded-acronym

In this case, even though I have expanded the acronym JWT as JSON Web Token, the rule still sees this as an error because the unexpansion itself contains an acronym (JSON). If I were to expand it as Json Web Token, then it works.

@amimas
Copy link
Author

amimas commented Mar 19, 2019

Also, this rule should work if an acronym had been expanded prior to where it was first introduced. For example, the following I think is valid but the rule detects this as an error because it's expecting the acronym to be expanded after it was mentioned.

  • It will be using an external proxy, such as an Amazon Elastic Load Balancer (ELB)

@azu azu added Type: Bug Bug or Bug fixes Type: Feature New Feature labels Mar 22, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Bug Bug or Bug fixes Type: Feature New Feature
Projects
None yet
Development

No branches or pull requests

2 participants