Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: link to JSDoc EOL blogpost in valid-jsdoc and require-jsdoc #11191

Merged
merged 3 commits into from Dec 13, 2018
Merged

Docs: link to JSDoc EOL blogpost in valid-jsdoc and require-jsdoc #11191

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e2e866d
Linked to blog post about jsdoc deprecation
ibbignerd Dec 13, 2018
9b44bad
Linked to blog post about jsdoc deprecation
ibbignerd Dec 13, 2018
f1fa181
Merge pull request #1 from ibbignerd/master
ibbignerd Dec 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/rules/require-jsdoc.md
View file
Open in desktop
@@ -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:

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/valid-jsdoc.md
View file
Open in desktop
@@ -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:

Expand Down