Skip to content

Commit

Permalink
fix: point to multipage docs; fixes #1094
Browse files Browse the repository at this point in the history
  • Loading branch information
brettz9 committed May 26, 2023
1 parent 6824ab6 commit f1183cc
Show file tree
Hide file tree
Showing 51 changed files with 51 additions and 51 deletions.
2 changes: 1 addition & 1 deletion src/bin/generateRule.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: '',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-${ruleName}',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkAccess.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Checks that `@access` tags have a valid value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-access',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header',
},
type: 'suggestion',
},
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkAlignment.js
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports invalid alignment of JSDoc block asterisks.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-alignment',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header',
},
fixable: 'code',
type: 'layout',
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkExamples.js
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkIndentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports invalid padding inside JSDoc blocks.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkLineAlignment.js
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports invalid alignment of JSDoc block lines.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md#repos-sticky-header',
},
fixable: 'whitespace',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkParamNames.js
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Ensures that parameter names in JSDoc match those in the function declaration.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkPropertyNames.js
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkSyntax.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-syntax',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header',
},
type: 'suggestion',
},
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkTagNames.js
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports invalid block tag names.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -489,7 +489,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports invalid types.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-types',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-types.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/checkValues.js
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'This rule checks the values for a handful of tags: `@version`, `@since`, `@license` and `@author`.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-values',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-values.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/emptyTags.js
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Expects specific tags to be empty of any content.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-empty-tags',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/empty-tags.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/implementsOnClasses.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports an issue with any non-constructor function using `@implements`.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-implements-on-classes',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/implements-on-classes.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/matchDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Enforces a regular expression pattern on descriptions.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-description',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-description.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/matchName.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports the name portion of a JSDoc tag if matching or not matching a given regular expression.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-match-name',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/match-name.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/multilineBlocks.js
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Controls how and whether jsdoc blocks can be expressed as single or multiple line blocks.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-multiline-blocks',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/multiline-blocks.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noBadBlocks.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'This rule checks for multi-line-style comments which fail to meet the criteria of a jsdoc block.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-bad-blocks',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-bad-blocks.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noBlankBlockDescriptions.js
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Detects and removes extra lines of a blank block description',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-blank-block-descriptions',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-block-descriptions.md#repos-sticky-header',
},
fixable: 'whitespace',
schema: [],
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noBlankBlocks.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Removes empty blocks with nothing but possibly line breaks',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-blank-blocks',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-blank-blocks.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noDefaults.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'This rule reports defaults being used on the relevant portion of `@param` or `@default`.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-defaults',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-defaults.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noMissingSyntax.js
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports when certain comment structures are always expected.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-missing-syntax',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-missing-syntax.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noMultiAsterisks.js
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: '',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-multi-asterisks',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-multi-asterisks.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noRestrictedSyntax.js
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Reports when certain comment structures are present.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-restricted-syntax',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-restricted-syntax.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'This rule reports types being used on `@param` or `@returns`.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-types',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-types.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/noUndefinedTypes.js
Original file line number Diff line number Diff line change
Expand Up @@ -294,7 +294,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Checks that types in jsdoc comments are defined.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-no-undefined-types',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/no-undefined-types.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that all functions have a description.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireDescriptionCompleteSentence.js
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that block description, explicit `@description`, and `@param`/`@returns` tag descriptions are written in complete sentences.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-description-complete-sentence',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-description-complete-sentence.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireExample.js
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that all functions have examples.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-example',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-example.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireFileOverview.js
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Checks that all files have one `@file`, `@fileoverview`, or `@overview` tag at the beginning of the file.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-file-overview',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-file-overview.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireHyphenBeforeParamDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires a hyphen before the `@param` description.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-hyphen-before-param-description',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-hyphen-before-param-description.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireJsdoc.js
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@ export default {
category: 'Stylistic Issues',
description: 'Require JSDoc comments',
recommended: true,
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-jsdoc',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-jsdoc.md#repos-sticky-header',
},

fixable: 'code',
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireParam.js
Original file line number Diff line number Diff line change
Expand Up @@ -494,7 +494,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that all function parameters are documented.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireParamDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that each `@param` tag has a `description` value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-description',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-description.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireParamName.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that all function parameters have names.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-name',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-name.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireParamType.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that each `@param` tag has a `type` value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-param-type',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-param-type.md#repos-sticky-header',
},
fixable: 'code',
schema: [
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireProperty.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that all `@typedef` and `@namespace` tags have `@property` when their type is a plain `object`, `Object`, or `PlainObject`.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property.md#repos-sticky-header',
},
fixable: 'code',
type: 'suggestion',
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requirePropertyDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that each `@property` tag has a `description` value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-description',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-description.md#repos-sticky-header',
},
type: 'suggestion',
},
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requirePropertyName.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that all function `@property` tags have names.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-name',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-name.md#repos-sticky-header',
},
type: 'suggestion',
},
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requirePropertyType.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that each `@property` tag has a `type` value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-property-type',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-property-type.md#repos-sticky-header',
},
type: 'suggestion',
},
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireReturns.js
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that returns are documented.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireReturnsCheck.js
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires a return statement in function body if a `@returns` tag is specified in jsdoc comment.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-check',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-check.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireReturnsDescription.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that the `@returns` tag has a `description` value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-description',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-description.md#repos-sticky-header',
},
schema: [
{
Expand Down
2 changes: 1 addition & 1 deletion src/rules/requireReturnsType.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ export default iterateJsdoc(({
meta: {
docs: {
description: 'Requires that `@returns` tag has `type` value.',
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-require-returns-type',
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/require-returns-type.md#repos-sticky-header',
},
schema: [
{
Expand Down
Loading

0 comments on commit f1183cc

Please sign in to comment.