Skip to content

Commit 95f15e6

Browse files
vplasenciacedoor
andauthored
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]>
1 parent 020a902 commit 95f15e6

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"private": true,
44
"packageManager": "[email protected]",
55
"scripts": {
6-
"build": "yarn build:libraries && yarn compile:libraries",
6+
"build": "yarn build:libraries && yarn compile:contracts",
77
"build:libraries": "yarn workspaces foreach -A --no-private run build",
88
"compile:contracts": "yarn workspace contract-extensions compile",
99
"test": "yarn test:libraries && yarn test:contracts && yarn test:circuits",

packages/contracts/contracts/SemaphoreWhistleblowing.sol

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ contract SemaphoreWhistleblowing is ISemaphoreWhistleblowing {
2323
_;
2424
}
2525

26-
/// @dev Initializes the Semaphore group used to verify the user's ZK proofs.
27-
/// @param _semaphore: Semaphore group address.
26+
/// @dev Initializes the Semaphore instance.
27+
/// @param _semaphore: Semaphore contract address.
2828
constructor(ISemaphore _semaphore) {
2929
semaphore = _semaphore;
3030
}

packages/contracts/contracts/interfaces/ISemaphoreWhistleblowing.sol

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,9 @@ interface ISemaphoreWhistleblowing {
1515
/// @param leak: News leak.
1616
event LeakPublished(uint256 indexed entityId, uint256 leak);
1717

18-
/// @dev Creates an entity and the associated Merkle tree/group.
18+
/// @dev Creates an entity and its associated Merkle tree/group.
19+
/// An entity represents a group of individuals, such as an organization or
20+
/// event participants.
1921
/// @param editor: Editor of the entity.
2022
function createEntity(address editor) external;
2123

0 commit comments

Comments
 (0)