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.

Sign up for GitHub

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

Jump to bottom

require-description-complete-sentence: Add an option to specify abbreviations #424

Closed
sveyret opened this issue Nov 8, 2019 · 2 comments · Fixed by #457
Closed

require-description-complete-sentence: Add an option to specify abbreviations #424

sveyret opened this issue Nov 8, 2019 · 2 comments · Fixed by #457
Labels
enhancement released

Comments

@sveyret
Copy link

sveyret commented Nov 8, 2019

I often use abbreviations such as i.e. or e.g. in my comments. The rule require-description-complete-sentence requires that these abbreviations are followed by an uppercase letter. It would be great to have a rule option to indicate which abbreviations we currently use and are terminated by a period which may not be followed by an uppercase.
@lextoc
Copy link

lextoc commented Nov 20, 2019

Having the same issue. For the sake of example:

/**
 * ...
 * - Do not have dynamic content; e.g. Homepage. Here a simple unique id
 * suffices.
 * ...
 */

Should be (but gets wrongly corrected):

/**
 * ...
 * - Do not have dynamic content; e.g. homepage. Here a simple unique id
 * suffices.
 * ...
 */

Loving this plugin, great job!

brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 27, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
39c599d 
…tion; fixes gajus#424
@brettz9 brettz9 mentioned this issue Dec 27, 2019
Merged
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 27, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
107e386 
…tion; fixes gajus#424
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 28, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
fcbcc68 
…tion; fixes gajus#424
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 28, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
b4d88a1 
…tion; fixes gajus#424
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 29, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
41db135 
…tion; fixes gajus#424
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 29, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
9f27f40 
…tion; fixes gajus#424
brettz9 added a commit to brettz9/eslint-plugin-jsdoc that referenced this issue Dec 31, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
0261afb 
…tion; fixes gajus#424
brettz9 added a commit that referenced this issue Dec 31, 2019
@brettz9
feat(require-description-complete-sentence): add abbreviations op…
f70fd6c 
…tion; fixes #424
@gajus
Copy link
Owner

gajus commented Dec 31, 2019

🎉 This issue has been resolved in version 18.8.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gajus gajus added the released label Dec 31, 2019
@snyk-bot snyk-bot mentioned this issue Mar 15, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement released
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

require-description-complete-sentence: abbreviations option brettz9/eslint-plugin-jsdoc
4 participants
@brettz9 @gajus @lextoc @sveyret