File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11# jsdoc-markdown-remark
22
3- > [ ESLint rule] [ eslint-rules ] to enforce that JSDoc descriptions are valid Markdown ( using [ remark] [ remark ] ) .
3+ > [ ESLint rule] [ eslint-rules ] to lint JSDoc descriptions using [ remark] [ remark ] .
44
55<section class =" intro " >
66
Original file line number Diff line number Diff line change 11'use strict' ;
22
33/**
4- * ESLint rule to enforce that JSDoc descriptions are valid Markdown ( using remark) .
4+ * ESLint rule to lint JSDoc descriptions using remark.
55*
66* @module @stdlib /_tools/eslint/rules/jsdoc-markdown-remark
77*
Original file line number Diff line number Diff line change @@ -20,7 +20,7 @@ var DOPTS = {
2020// MAIN //
2121
2222/**
23- * Rule for validating that JSDoc descriptions are valid Markdown ( using remark) .
23+ * Rule for linting JSDoc descriptions using remark.
2424*
2525* @param {Object } context - ESLint context
2626* @returns {Object } validators
@@ -49,7 +49,7 @@ function main( context ) {
4949 } ;
5050
5151 /**
52- * Validates whether JSDoc descriptions are valid Markdown .
52+ * Lints JSDoc descriptions.
5353 *
5454 * @private
5555 * @param {ASTNode } node - AST node
@@ -124,7 +124,7 @@ function main( context ) {
124124module . exports = {
125125 'meta' : {
126126 'docs' : {
127- 'description' : 'enforce that JSDoc descriptions are valid Markdown ( using remark) '
127+ 'description' : 'lint JSDoc descriptions using remark'
128128 } ,
129129 'schema' : [
130130 {
Original file line number Diff line number Diff line change 11{
22 "name" : " @stdlib/_tools/eslint/rules/jsdoc-markdown-remark" ,
33 "version" : " 0.0.0" ,
4- "description" : " ESLint rule to enforce that JSDoc descriptions are valid Markdown ( using remark) ." ,
4+ "description" : " ESLint rule to lint JSDoc descriptions using remark." ,
55 "license" : " Apache-2.0" ,
66 "author" : {
77 "name" : " The Stdlib Authors" ,
You can’t perform that action at this time.
0 commit comments