chore: add descriptions to Grunt tasks (#459)

Closes #364
dequelabs · Jul 31, 2017 · 93a0273 · 93a0273
1 parent d02dba3
commit 93a0273
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 9 deletions.
diff --git a/build/tasks/add-locale.js b/build/tasks/add-locale.js
@@ -3,7 +3,9 @@
 var buildManual = require('../build-manual');
 
 module.exports = function (grunt) {
-  grunt.registerMultiTask('add-locale', function () {
+  grunt.registerMultiTask('add-locale',
+  'Task for localizing messages in rules and checks',
+  function () {
     var options = this.options({
       rules: ['lib/rules/**/*.json'],
       checks: ['lib/checks/**/*.json'],

diff --git a/build/tasks/configure.js b/build/tasks/configure.js
@@ -2,8 +2,9 @@
 'use strict';
 var buildRules = require('../configure');
 module.exports = function (grunt) {
-	grunt.registerMultiTask('configure', function () {
-
+	grunt.registerMultiTask('configure',
+	'Task for configuring rules and checks',
+	function () {
 		var done = this.async();
 		var options = this.options({
       rules: ['lib/rules/**/*.json'],

diff --git a/build/tasks/fixture.js b/build/tasks/fixture.js
@@ -2,7 +2,9 @@
 'use strict';
 
 module.exports = function (grunt) {
-	grunt.registerMultiTask('fixture', function () {
+	grunt.registerMultiTask('fixture',
+	'Task for generating HTML test fixtures from a common template',
+	function () {
 		var options = this.options({
 			fixture: 'test/runner.tmpl',
 			testCwd: 'test/core',

diff --git a/build/tasks/langs.js b/build/tasks/langs.js
@@ -47,7 +47,9 @@ module.exports = function (grunt) {
 		].join('');
 		grunt.file.write(path, template);
 	}
-	grunt.registerMultiTask('langs', function () {
+	grunt.registerMultiTask('langs',
+	'Task for generating commons language codes from IANA registry',
+	function () {
 		var done = this.async();
 		var ianaLangsURL = 'http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry';
 		if (!this.data.check) {

diff --git a/build/tasks/test-webdriver.js b/build/tasks/test-webdriver.js
@@ -117,7 +117,9 @@ module.exports = function (grunt) {
 	/**
 	 * Run all tests in a browser using webdriver
 	 */
-	grunt.registerMultiTask('test-webdriver', function () {
+	grunt.registerMultiTask('test-webdriver',
+	'Task for launching Webdriver with options and running tests against options URLs',
+	function () {
 		var driver;
 		var done = this.async();
 		var options = this.options({

diff --git a/build/tasks/testconfig.js b/build/tasks/testconfig.js
@@ -3,7 +3,7 @@
 
 module.exports = function (grunt) {
 	grunt.registerMultiTask('testconfig',
-	'This task creates a file with all the source test config and HTML fixutres in a single JS object "test"',
+	'This task creates a file with all the source test config and HTML fixtures in a single JS object `tests`',
 	function () {
 
 		var result = {

diff --git a/build/tasks/update-help.js b/build/tasks/update-help.js
@@ -2,7 +2,9 @@
 'use strict';
 
 module.exports = function (grunt) {
-	grunt.registerMultiTask('update-help', function () {
+	grunt.registerMultiTask('update-help',
+	'Task for updating Deque University helpUrls based on rule JSON files',
+	function () {
 		var options = this.options({
 			version: '1.0.0'
 		});

diff --git a/build/tasks/validate.js b/build/tasks/validate.js
@@ -233,7 +233,9 @@ function validateFiles(grunt, files, schema) {
 }
 
 module.exports = function (grunt) {
-	grunt.registerMultiTask('validate', function () {
+	grunt.registerMultiTask('validate',
+	'Task for validating API schema for tools, checks and rules',
+	function () {
 		var schemas = createSchemas();
 		var options = this.options();
 		if (!options.type || !schemas[options.type]) {