Better variable names in createSubsidiary

windingtree · Jun 7, 2020 · 5c17de8 · 5c17de8
1 parent 877c42f
commit 5c17de8
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 21 deletions.
diff --git a/contracts/OrgId.sol b/contracts/OrgId.sol
@@ -172,34 +172,34 @@ contract OrgId is OrgIdInterface, Ownable, ERC165, Initializable {
 
     /**
      * @dev Create organizational unit
-     * @param orgId Parent ORG.ID hash
-     * @param subsidiaryDirector Unit's director address
-     * @param orgJsonUri Unit's ORG.JSON URI
-     * @param orgJsonHash ORG.JSON's keccak256 hash
+     * @param parentOrgId Parent ORG.ID hash
+     * @param director Unit director address
+     * @param orgJsonUri Unit ORG.JSON URI
+     * @param orgJsonHash ORG.JSON keccak256 hash
      */
     function createSubsidiary(
-        bytes32 orgId,
-        address subsidiaryDirector,
+        bytes32 parentOrgId,
+        address director,
         string calldata orgJsonUri,
         bytes32 orgJsonHash
     )
         external
-        orgIdMustExist(orgId)
-        mustBeCalledByOwner(orgId)
-        returns (bytes32 id)
+        orgIdMustExist(parentOrgId)
+        mustBeCalledByOwner(parentOrgId)
+        returns (bytes32 newUnitOrgId)
     {
-        id = _createOrganization(
-            orgId,
-            subsidiaryDirector,
+        newUnitOrgId = _createOrganization(
+            parentOrgId,
+            director,
             orgJsonUri,
             orgJsonHash
         );
-        emit SubsidiaryCreated(orgId, id, subsidiaryDirector);
+        emit SubsidiaryCreated(parentOrgId, newUnitOrgId, director);
 
         // If parent ORG.ID owner indicates their address as director,
         // their directorship is automatically confirmed
-        if (subsidiaryDirector == msg.sender) {
-            emit DirectorOwnershipConfirmed(id, msg.sender);
+        if (director == msg.sender) {
+            emit DirectorOwnershipConfirmed(newUnitOrgId, msg.sender);
         }
     }
 

diff --git a/contracts/OrgIdInterface.sol b/contracts/OrgIdInterface.sol
@@ -20,14 +20,14 @@ contract OrgIdInterface {
 
     /**
      * @dev Create organizational unit
-     * @param orgId Parent ORG.ID hash
-     * @param subsidiaryDirector Unit's director address
-     * @param orgJsonUri Unit's ORG.JSON URI
-     * @param orgJsonHash ORG.JSON's keccak256 hash
+     * @param parentOrgId Parent ORG.ID hash
+     * @param director Unit director address
+     * @param orgJsonUri Unit ORG.JSON URI
+     * @param orgJsonHash ORG.JSON keccak256 hash
      */
     function createSubsidiary(
-        bytes32 orgId,
-        address subsidiaryDirector,
+        bytes32 parentOrgId,
+        address director,
         string calldata orgJsonUri,
         bytes32 orgJsonHash
     ) external returns (bytes32 id);