You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is similar to #705, but regarding capitalization at the start of a sentence rather than punctuation at the end of it.
Expected behavior
If a JSDoc comment starts with an inline {@link} tag, jsdoc/require-description-complete-sentence should not fail as long as the text starts with a capital letter and ends with a period.
Actual behavior
The above code sample fails jsdoc/require-description-complete-sentence because the linting rule thinks the description starts with {, which is not a capital letter.
I think we should just blanket permit inline tags at the beginning of a sentence. Besides the link possibly being a URL, it may be a variable name or such and not call for capitalization, so I think we should just allow any inline tags at the beginning.
brettz9
added a commit
to brettz9/eslint-plugin-jsdoc
that referenced
this issue
Sep 14, 2023
This is similar to #705, but regarding capitalization at the start of a sentence rather than punctuation at the end of it.
Expected behavior
If a JSDoc comment starts with an inline
{@link}
tag, jsdoc/require-description-complete-sentence should not fail as long as the text starts with a capital letter and ends with a period.Actual behavior
The above code sample fails jsdoc/require-description-complete-sentence because the linting rule thinks the description starts with
{
, which is not a capital letter.ESLint Config
ESLint sample
/** @param options {@link RequestOptions} specifying path parameters and query parameters. */
Environment
eslint-plugin-jsdoc
version: 46.2.6The text was updated successfully, but these errors were encountered: