docs(contracts): improve whistleblowing contract docs (#18)

* docs(contracts): improve whistleblowing contract docs * Update packages/contracts/contracts/SemaphoreWhistleblowing.sol Co-authored-by: Cedoor <[email protected]> --------- Co-authored-by: Cedoor <[email protected]>
semaphore-protocol · Sep 12, 2024 · 95f15e6 · 95f15e6
1 parent 020a902
commit 95f15e6
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 4 deletions.
diff --git a/package.json b/package.json
@@ -3,7 +3,7 @@
     "private": true,
     "packageManager": "[email protected]",
     "scripts": {
-        "build": "yarn build:libraries && yarn compile:libraries",
+        "build": "yarn build:libraries && yarn compile:contracts",
         "build:libraries": "yarn workspaces foreach -A --no-private run build",
         "compile:contracts": "yarn workspace contract-extensions compile",
         "test": "yarn test:libraries && yarn test:contracts && yarn test:circuits",

diff --git a/packages/contracts/contracts/SemaphoreWhistleblowing.sol b/packages/contracts/contracts/SemaphoreWhistleblowing.sol
@@ -23,8 +23,8 @@ contract SemaphoreWhistleblowing is ISemaphoreWhistleblowing {
         _;
     }
 
-    /// @dev Initializes the Semaphore group used to verify the user's ZK proofs.
-    /// @param _semaphore: Semaphore group address.
+    /// @dev Initializes the Semaphore instance.
+    /// @param _semaphore: Semaphore contract address.
     constructor(ISemaphore _semaphore) {
         semaphore = _semaphore;
     }

diff --git a/packages/contracts/contracts/interfaces/ISemaphoreWhistleblowing.sol b/packages/contracts/contracts/interfaces/ISemaphoreWhistleblowing.sol
@@ -15,7 +15,9 @@ interface ISemaphoreWhistleblowing {
     /// @param leak: News leak.
     event LeakPublished(uint256 indexed entityId, uint256 leak);
 
-    /// @dev Creates an entity and the associated Merkle tree/group.
+    /// @dev Creates an entity and its associated Merkle tree/group.
+    /// An entity represents a group of individuals, such as an organization or
+    /// event participants.
     /// @param editor: Editor of the entity.
     function createEntity(address editor) external;