From 733d93618a99758a05453ab94505a9f1330950e0 Mon Sep 17 00:00:00 2001 From: Nathan Diddle Date: Wed, 12 Dec 2018 23:50:20 -0500 Subject: [PATCH] Docs: link to JSDoc EOL blogpost in valid-jsdoc and require-jsdoc (#11191) --- docs/rules/require-jsdoc.md | 2 +- docs/rules/valid-jsdoc.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/rules/require-jsdoc.md b/docs/rules/require-jsdoc.md index 8f6ffeb734a..1e31aedf74c 100644 --- a/docs/rules/require-jsdoc.md +++ b/docs/rules/require-jsdoc.md @@ -1,6 +1,6 @@ # require JSDoc comments (require-jsdoc) -This rule was **deprecated** in ESLint v5.10.0. +This rule was [**deprecated**](https://eslint.org/blog/2018/11/jsdoc-end-of-life) in ESLint v5.10.0. [JSDoc](http://usejsdoc.org) is a JavaScript API documentation generator. It uses specially-formatted comments inside of code to generate API documentation automatically. For example, this is what a JSDoc comment looks like for a function: diff --git a/docs/rules/valid-jsdoc.md b/docs/rules/valid-jsdoc.md index 8764537219a..2d503828f35 100644 --- a/docs/rules/valid-jsdoc.md +++ b/docs/rules/valid-jsdoc.md @@ -1,6 +1,6 @@ # enforce valid JSDoc comments (valid-jsdoc) -This rule was **deprecated** in ESLint v5.10.0. +This rule was [**deprecated**](https://eslint.org/blog/2018/11/jsdoc-end-of-life) in ESLint v5.10.0. [JSDoc](http://usejsdoc.org) generates application programming interface (API) documentation from specially-formatted comments in JavaScript code. For example, this is a JSDoc comment for a function: