Skip to content

Commit 2f8aa47

Browse files
author
RTLcoil
authored
Fix and improve docstring for download_folder() (#434)
* Fix and improve docstring for `download_folder()`
1 parent afe8fae commit 2f8aa47

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

lib-es5/utils/index.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1187,7 +1187,10 @@ function download_zip_url() {
11871187
}
11881188

11891189
/**
1190-
* Creates and downloads a URL that when invokes creates an archive of a folder
1190+
* Creates and returns a URL that when invoked creates an archive of a folder
1191+
* @param {string} folder_path Full path (from the root) of the folder to download
1192+
* @param {object} options Additional options
1193+
* @returns {string} Url for downloading an archive of a folder
11911194
*/
11921195
function download_folder(folder_path) {
11931196
var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};

lib/utils/index.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1090,7 +1090,10 @@ function download_zip_url(options = {}) {
10901090
}
10911091

10921092
/**
1093-
* Creates and downloads a URL that when invokes creates an archive of a folder
1093+
* Creates and returns a URL that when invoked creates an archive of a folder
1094+
* @param {string} folder_path Full path (from the root) of the folder to download
1095+
* @param {object} options Additional options
1096+
* @returns {string} Url for downloading an archive of a folder
10941097
*/
10951098
function download_folder(folder_path, options = {}) {
10961099
options.resource_type = options.resource_type || "all";

0 commit comments

Comments
 (0)