Skip to content

Commit 5bcb0d4

Browse files
committed
Mark authorize function as private, adapt description
1 parent e7e222b commit 5bcb0d4

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/remotestorage.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -174,14 +174,16 @@ RemoteStorage.prototype = {
174174
/**
175175
* Initiate the OAuth authorization flow.
176176
*
177-
* This function is usually not called by an app directly, but rather from a
178-
* custom storage backend implementation (e.g. Dropbox or Google Drive).
177+
* This function is called by custom storage backend implementations
178+
* (e.g. Dropbox or Google Drive).
179179
*
180180
* @param {object} options
181181
* @param {string} options.authURL - URL of the authorization endpoint
182182
* @param {string} [options.scope] - access scope
183183
* @param {string} [options.clientId] - client identifier (defaults to the
184184
* origin of the redirectUri)
185+
*
186+
* @private
185187
*/
186188
authorize: function authorize (options) {
187189
this.access.setStorageType(this.remote.storageApi);

0 commit comments

Comments
 (0)