From 617a2874ed085bca36ca289aac55e3b7f7ce937e Mon Sep 17 00:00:00 2001 From: Teddy Katz Date: Sat, 8 Dec 2018 01:44:10 -0500 Subject: [PATCH] Docs: add missing deprecation notices for jsdoc rules (#11171) The rules were deprecated in the last release, but the deprecation notices in the documentation are not autogenerated. --- docs/rules/require-jsdoc.md | 2 ++ docs/rules/valid-jsdoc.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/rules/require-jsdoc.md b/docs/rules/require-jsdoc.md index b9deb7daa69..8f6ffeb734a 100644 --- a/docs/rules/require-jsdoc.md +++ b/docs/rules/require-jsdoc.md @@ -1,5 +1,7 @@ # require JSDoc comments (require-jsdoc) +This rule was **deprecated** 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: ```js diff --git a/docs/rules/valid-jsdoc.md b/docs/rules/valid-jsdoc.md index 4e23a5eee4c..8764537219a 100644 --- a/docs/rules/valid-jsdoc.md +++ b/docs/rules/valid-jsdoc.md @@ -1,5 +1,7 @@ # enforce valid JSDoc comments (valid-jsdoc) +This rule was **deprecated** 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: ```js