From 0fe8556ced63d714e0cd371a8511c8dadce7874e Mon Sep 17 00:00:00 2001 From: Hisham Muhammad Date: Mon, 13 Apr 2015 21:29:38 -0300 Subject: Update function documentation, as suggested by @ignacio in #347. --- src/luarocks/search.lua | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'src') diff --git a/src/luarocks/search.lua b/src/luarocks/search.lua index 53439386..f1a82d5b 100644 --- a/src/luarocks/search.lua +++ b/src/luarocks/search.lua @@ -155,10 +155,11 @@ function search.disk_search(repo, query, results) return results end ---- Perform search on a rocks server. +--- Perform search on a rocks server or tree. -- @param results table: The results table, where keys are package names and -- versions are tables matching version strings to an array of servers. --- @param repo string: The URL of the rocks server. +-- @param repo string: The URL of a rocks server or +-- the pathname of a rocks tree (as returned by path.rocks_dir()). -- @param query table: A table describing the query in dependency -- format (for example, {name = "filesystem", exact_name = false, -- constraints = {op = "~>", version = {1,0}}}, arch = "rockspec"). -- cgit v1.2.3-55-g6feb