Update eslint doc comment

[stefanprobst]

the behavior of the eslint.dirs config option was changed in #26401. this pr adjusts the doc comment accordingly.

Bug

• Related issues linked using fixes #number
• Integration tests added
• Errors have helpful link attached, see contributing.md

Feature

• Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
• Related issues linked using fixes #number
• Integration tests added
• Documentation added
• Telemetry added. In case of a feature if it's used or not.
• Errors have helpful link attached, see contributing.md

Documentation / Examples

• Make sure the linting passes

[ijjk]

Stats from current PR

Default Build (Decrease detected ✓)

General Overall decrease ✓

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
buildDuration	15.8s	15.7s	-109ms
buildDurationCached	3.6s	3.5s	-50ms
nodeModulesSize	49.5 MB	49.5 MB	-12 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.615	2.735	⚠️ +0.12
/ avg req/sec	956.08	914.23	⚠️ -41.85
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.468	1.498	⚠️ +0.03
/error-in-render avg req/sec	1702.64	1668.81	⚠️ -33.83

Client Bundles (main, webpack, commons)

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
359.HASH.js gzip	2.96 kB	2.96 kB	✓
745.HASH.js gzip	180 B	180 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	21 kB	21 kB	✓
webpack-HASH.js gzip	1.53 kB	1.53 kB	✓
Overall change	67.9 kB	67.9 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
polyfills-HASH.js gzip	31.1 kB	31.1 kB	✓
Overall change	31.1 kB	31.1 kB	✓

Client Pages

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
_app-HASH.js gzip	803 B	803 B	✓
_error-HASH.js gzip	3.06 kB	3.06 kB	✓
amp-HASH.js gzip	554 B	554 B	✓
css-HASH.js gzip	329 B	329 B	✓
dynamic-HASH.js gzip	2.52 kB	2.52 kB	✓
head-HASH.js gzip	2.28 kB	2.28 kB	✓
hooks-HASH.js gzip	903 B	903 B	✓
image-HASH.js gzip	5.63 kB	5.63 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	319 B	319 B	✓
script-HASH.js gzip	387 B	387 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	19.1 kB	19.1 kB	✓

Client Build Manifests

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
_buildManifest.js gzip	489 B	489 B	✓
Overall change	489 B	489 B	✓

Rendered Page Sizes

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
index.html gzip	531 B	531 B	✓
link.html gzip	542 B	542 B	✓
withRouter.html gzip	525 B	525 B	✓
Overall change	1.6 kB	1.6 kB	✓

---

Webpack 4 Mode (Decrease detected ✓)

General Overall decrease ✓

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
buildDuration	12.6s	12.5s	-77ms
buildDurationCached	4.9s	4.7s	-147ms
nodeModulesSize	49.5 MB	49.5 MB	-12 B

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.645	2.593	-0.05
/ avg req/sec	945	963.96	+18.96
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.462	1.503	⚠️ +0.04
/error-in-render avg req/sec	1710.29	1663.19	⚠️ -47.1

Client Bundles (main, webpack, commons)

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
17.HASH.js gzip	2.98 kB	2.98 kB	✓
18.HASH.js gzip	185 B	185 B	✓
677f882d2ed8..HASH.js gzip	13.8 kB	13.8 kB	✓
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	8.4 kB	8.4 kB	✓
webpack-HASH.js gzip	1.22 kB	1.22 kB	✓
Overall change	68.5 kB	68.5 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
polyfills-HASH.js gzip	31.3 kB	31.3 kB	✓
Overall change	31.3 kB	31.3 kB	✓

Client Pages

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
_app-HASH.js gzip	791 B	791 B	✓
_error-HASH.js gzip	3.76 kB	3.76 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.71 kB	2.71 kB	✓
head-HASH.js gzip	2.97 kB	2.97 kB	✓
hooks-HASH.js gzip	911 B	911 B	✓
index-HASH.js gzip	231 B	231 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	298 B	298 B	✓
script-HASH.js gzip	3.02 kB	3.02 kB	✓
withRouter-HASH.js gzip	294 B	294 B	✓
e025d2764813..52f.css gzip	125 B	125 B	✓
Overall change	17.6 kB	17.6 kB	✓

Client Build Manifests

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
_buildManifest.js gzip	500 B	500 B	✓
Overall change	500 B	500 B	✓

Rendered Page Sizes

	vercel/next.js canary	stefanprobst/next.js docs/adjust-eslint-doc-comment	Change
index.html gzip	576 B	576 B	✓
link.html gzip	588 B	588 B	✓
withRouter.html gzip	569 B	569 B	✓
Overall change	1.73 kB	1.73 kB	✓

Commit: 1f6cbff

[ijjk]

Thanks!