Merge 76c1ba1 into 0ad0476

Esri · Aug 15, 2018 · 6046cff · 6046cff
2 parents 0ad0476 + 76c1ba1
commit 6046cff
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/packages/arcgis-rest-request/src/utils/get-portal-url.ts b/packages/arcgis-rest-request/src/utils/get-portal-url.ts
@@ -3,8 +3,8 @@
 import { IRequestOptions } from "../request";
 
 /**
- * Helper that returns the portalUrl - either defaulting to www.arcgis.com or using
- * the passed in auth manager's .portal property
+ * Helper that returns the appropriate portal url for a given request. `requestOptions.portal` is given
+ * precedence over `authentication.portal`. If neither are present, `www.arcgis.com/sharing/rest` is returned.
  *
  * @param requestOptions - Request options that may have authentication manager
  * @returns Portal url to be used in API requests
@@ -15,7 +15,7 @@ export function getPortalUrl(requestOptions: IRequestOptions = {}): string {
     return requestOptions.portal;
   }
 
-  // if the auth was passed, use that portal
+  // if auth was passed, use that portal
   if (requestOptions.authentication) {
     return requestOptions.authentication.portal;
   }