Closed jnbooth closed 11 months ago
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.
:tada: This issue has been resolved in version 46.8.1 :tada:
The release is available on:
Your semantic-release bot :package::rocket:
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
Environment
eslint-plugin-jsdoc
version: 46.2.6