Skip to content

Commit e7e222b

Browse files
committed
Add note to authorize function documentation
1 parent c88d77b commit e7e222b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

src/remotestorage.js

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,9 @@ 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).
179+
*
177180
* @param {object} options
178181
* @param {string} options.authURL - URL of the authorization endpoint
179182
* @param {string} [options.scope] - access scope

0 commit comments

Comments
 (0)