@@ -35,7 +35,7 @@ sassLint.getConfig = function (config, configPath) {
35
35
* Parses our results object to count errors and return
36
36
* paths to files with detected errors.
37
37
*
38
- * @param {object } results our results object
38
+ * @param {Array } results our results Array
39
39
* @returns {object } errors object containing the error count and paths for files incl. errors
40
40
*/
41
41
sassLint . errorCount = function ( results ) {
@@ -58,7 +58,7 @@ sassLint.errorCount = function (results) {
58
58
* Parses our results object to count warnings and return
59
59
* paths to files with detected warnings.
60
60
*
61
- * @param {object } results our results object
61
+ * @param {Array } results our results array
62
62
* @returns {object } warnings object containing the error count and paths for files incl. warnings
63
63
*/
64
64
sassLint . warningCount = function ( results ) {
@@ -81,7 +81,7 @@ sassLint.warningCount = function (results) {
81
81
* Parses our results object to count warnings and errors and return
82
82
* a cumulative count of both
83
83
*
84
- * @param {object } results our results object
84
+ * @param {Array } results our results array
85
85
* @returns {int } the cumulative count of errors and warnings detected
86
86
*/
87
87
sassLint . resultCount = function ( results ) {
@@ -188,7 +188,7 @@ sassLint.lintFileText = function (file, options, configPath) {
188
188
* @param {string } files a glob pattern or single file path as a lint target
189
189
* @param {object } options user specified rules/options passed in
190
190
* @param {string } configPath path to a config file
191
- * @returns {object } results object containing all results
191
+ * @returns {Array } results object containing all results
192
192
*/
193
193
sassLint . lintFiles = function ( files , options , configPath ) {
194
194
var that = this ,
@@ -245,10 +245,10 @@ sassLint.lintFiles = function (files, options, configPath) {
245
245
/**
246
246
* Handles formatting of results using EsLint formatters
247
247
*
248
- * @param {object } results our results object
248
+ * @param {Array } results our results array
249
249
* @param {object } options user specified rules/options passed in
250
250
* @param {string } configPath path to a config file
251
- * @returns {object } results our results object in the user specified format
251
+ * @returns {string } results our results object in the user specified format
252
252
*/
253
253
sassLint . format = function ( results , options , configPath ) {
254
254
var config = this . getConfig ( options , configPath ) ,
@@ -263,10 +263,10 @@ sassLint.format = function (results, options, configPath) {
263
263
* Handles outputting results whether this be straight to the console/stdout or to a file.
264
264
* Passes results to the format function to ensure results are output in the chosen format
265
265
*
266
- * @param {object } results our results object
266
+ * @param {Array } results our results array
267
267
* @param {object } options user specified rules/options passed in
268
268
* @param {string } configPath path to a config file
269
- * @returns {object } results our results object
269
+ * @returns {string } the formatted results string
270
270
*/
271
271
sassLint . outputResults = function ( results , options , configPath ) {
272
272
var config = this . getConfig ( options , configPath ) ;
@@ -295,7 +295,7 @@ sassLint.outputResults = function (results, options, configPath) {
295
295
* Throws an error if there are any errors detected. The error includes a count of all errors
296
296
* and a list of all files that include errors.
297
297
*
298
- * @param {object } results - our results object
298
+ * @param {Array } results - our results array
299
299
* @param {object } [options] - extra options to use when running failOnError, e.g. max-warnings
300
300
* @param {string } [configPath] - path to the config file
301
301
* @returns {void }
0 commit comments