From 80f2acb37d4b6e59a12273713868cf1a65b7420f Mon Sep 17 00:00:00 2001 From: Ross Allen Date: Tue, 28 Jul 2015 14:39:11 -0700 Subject: [PATCH] Use `Returns` keyword to highlight vals in docs Use the `Returns` keyword in `PackageManager::getAvailablePackage*` docs so the return values are called out in panels like with other documentation. --- src/package-manager.coffee | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/package-manager.coffee b/src/package-manager.coffee index da349b6b3..2dd5f29cd 100644 --- a/src/package-manager.coffee +++ b/src/package-manager.coffee @@ -247,7 +247,7 @@ class PackageManager Section: Accessing available packages ### - # Public: Get an {Array} of {String}s of all the available package paths. + # Public: Returns an {Array} of {String}s of all the available package paths. getAvailablePackagePaths: -> packagePaths = [] @@ -262,11 +262,11 @@ class PackageManager _.uniq(packagePaths) - # Public: Get an {Array} of {String}s of all the available package names. + # Public: Returns an {Array} of {String}s of all the available package names. getAvailablePackageNames: -> _.uniq _.map @getAvailablePackagePaths(), (packagePath) -> path.basename(packagePath) - # Public: Get an {Array} of {String}s of all the available package metadata. + # Public: Returns an {Array} of {String}s of all the available package metadata. getAvailablePackageMetadata: -> packages = [] for packagePath in @getAvailablePackagePaths()