Skip to content

Commit f1183cc

Browse files
committed
fix: point to multipage docs; fixes #1094
1 parent 6824ab6 commit f1183cc

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+51
-51
lines changed

src/bin/generateRule.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ export default iterateJsdoc(({
6666
meta: {
6767
docs: {
6868
description: '',
69-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-${ruleName}',
69+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/${ruleName}.md#repos-sticky-header',
7070
},
7171
schema: [
7272
{

src/rules/checkAccess.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ export default iterateJsdoc(({
3838
meta: {
3939
docs: {
4040
description: 'Checks that `@access` tags have a valid value.',
41-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-access',
41+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-access.md#repos-sticky-header',
4242
},
4343
type: 'suggestion',
4444
},

src/rules/checkAlignment.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ export default iterateJsdoc(({
5555
meta: {
5656
docs: {
5757
description: 'Reports invalid alignment of JSDoc block asterisks.',
58-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-alignment',
58+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-alignment.md#repos-sticky-header',
5959
},
6060
fixable: 'code',
6161
type: 'layout',

src/rules/checkExamples.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -516,7 +516,7 @@ export default iterateJsdoc(({
516516
meta: {
517517
docs: {
518518
description: 'Ensures that (JavaScript) examples within JSDoc adhere to ESLint rules.',
519-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-examples',
519+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-examples.md#repos-sticky-header',
520520
},
521521
schema: [
522522
{

src/rules/checkIndentation.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ export default iterateJsdoc(({
5353
meta: {
5454
docs: {
5555
description: 'Reports invalid padding inside JSDoc blocks.',
56-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-indentation',
56+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-indentation.md#repos-sticky-header',
5757
},
5858
schema: [
5959
{

src/rules/checkLineAlignment.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ export default iterateJsdoc(({
309309
meta: {
310310
docs: {
311311
description: 'Reports invalid alignment of JSDoc block lines.',
312-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-line-alignment',
312+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-line-alignment.md#repos-sticky-header',
313313
},
314314
fixable: 'whitespace',
315315
schema: [

src/rules/checkParamNames.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -367,7 +367,7 @@ export default iterateJsdoc(({
367367
meta: {
368368
docs: {
369369
description: 'Ensures that parameter names in JSDoc match those in the function declaration.',
370-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-param-names',
370+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-param-names.md#repos-sticky-header',
371371
},
372372
fixable: 'code',
373373
schema: [

src/rules/checkPropertyNames.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ export default iterateJsdoc(({
133133
meta: {
134134
docs: {
135135
description: 'Ensures that property names in JSDoc are not duplicated on the same block and that nested properties have defined roots.',
136-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-property-names',
136+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-property-names.md#repos-sticky-header',
137137
},
138138
fixable: 'code',
139139
schema: [

src/rules/checkSyntax.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ export default iterateJsdoc(({
2323
meta: {
2424
docs: {
2525
description: 'Reports against syntax not valid for the mode (e.g., Google Closure Compiler in non-Closure mode).',
26-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-syntax',
26+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-syntax.md#repos-sticky-header',
2727
},
2828
type: 'suggestion',
2929
},

src/rules/checkTagNames.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -283,7 +283,7 @@ export default iterateJsdoc(({
283283
meta: {
284284
docs: {
285285
description: 'Reports invalid block tag names.',
286-
url: 'https://github.com/gajus/eslint-plugin-jsdoc#eslint-plugin-jsdoc-rules-check-tag-names',
286+
url: 'https://github.com/gajus/eslint-plugin-jsdoc/blob/main/docs/rules/check-tag-names.md#repos-sticky-header',
287287
},
288288
fixable: 'code',
289289
schema: [

0 commit comments

Comments
 (0)