Add comments

Expensify · Oct 11, 2022 · f9b0e4a · f9b0e4a
1 parent 9170edf
commit f9b0e4a
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/src/libs/actions/App.js b/src/libs/actions/App.js
@@ -187,6 +187,9 @@ function setUpPoliciesAndNavigate(session) {
     const isLoggingInAsNewUser = SessionUtils.isLoggingInAsNewUser(currentUrl, session.email);
     const url = new URL(currentUrl);
     const exitTo = url.searchParams.get('exitTo');
+
+    // Approved Accountants and Guides can enter a flow where they make a workspace for other users,
+    // and those are passed as a search parameter when using transition links
     const ownerEmail = url.searchParams.get('ownerEmail');
     const makeMeAdmin = url.searchParams.get('makeMeAdmin');
 

diff --git a/src/libs/actions/Policy.js b/src/libs/actions/Policy.js
@@ -763,6 +763,9 @@ function generatePolicyID() {
 
 /**
  * Optimistically creates a new workspace and default workspace chats
+ *
+ * @param {String} [ownerEmail] Optional, the email of the account to make the owner of the policy
+ * @param {Boolean} [makeMeAdmin] Optional, leave the calling account as an admin on the policy
  */
 function createWorkspace(ownerEmail = '', makeMeAdmin = false) {
     const policyID = generatePolicyID();