Skip to content

Commit

Permalink
Rename refs to events from Votes component to be explicit
Browse files Browse the repository at this point in the history
  • Loading branch information
immrsd committed Dec 10, 2024
1 parent 300bd57 commit cb291f3
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions docs/modules/ROOT/pages/api/governance.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@
:ITimelock-CallCancelled: xref:ITimelock-CallCancelled[CallCancelled]
:ITimelock-MinDelayChanged: xref:ITimelock-MinDelayChanged[MinDelayChanged]
:IAccessControl-RoleGranted: xref:api/access.adoc#IAccessControl-RoleGranted[IAccessControl::RoleGranted]
:DelegateChanged: xref:VotesComponent-DelegateChanged[DelegateChanged]
:DelegateVotesChanged: xref:VotesComponent-DelegateVotesChanged[DelegateVotesChanged]
:VotesComponent-DelegateChanged: xref:VotesComponent-DelegateChanged[DelegateChanged]
:VotesComponent-DelegateVotesChanged: xref:VotesComponent-DelegateVotesChanged[DelegateVotesChanged]
:VotingUnitsTrait: xref:VotingUnitsTrait[VotingUnitsTrait]
:VotesComponent: xref:VotesComponent[VotesComponent]
:IVotes: xref:IVotes[IVotes]
Expand Down Expand Up @@ -3347,9 +3347,9 @@ Returns the delegate that `account` has chosen.

Delegates votes from the sender to `delegatee`.

Emits a {DelegateChanged} event.
Emits a {VotesComponent-DelegateChanged} event.

May emit one or two {DelegateVotesChanged} events.
May emit one or two {VotesComponent-DelegateVotesChanged} events.

[.contract-item]
[[VotesComponent-delegate_by_sig]]
Expand All @@ -3364,9 +3364,9 @@ Requirements:
- `delegator` must implement `SRC6::is_valid_signature`.
- `signature` should be valid for the message hash.

Emits a {DelegateChanged} event.
Emits a {VotesComponent-DelegateChanged} event.

May emit one or two {DelegateVotesChanged} events.
May emit one or two {VotesComponent-DelegateVotesChanged} events.

[#VotesComponent-Internal-functions]
==== Internal functions
Expand All @@ -3383,7 +3383,7 @@ Returns the current total supply of votes.

Moves delegated votes from one delegate to another.

May emit one or two {DelegateVotesChanged} events.
May emit one or two {VotesComponent-DelegateVotesChanged} events.

[.contract-item]
[[VotesComponent-transfer_voting_units]]
Expand All @@ -3396,7 +3396,7 @@ should be zero. Total supply of voting units will be adjusted with mints and bur

WARNING: If voting units are based on an underlying transferable asset (like a token), you must call this function every time the asset is transferred to keep the internal voting power accounting in sync. For ERC20 and ERC721 tokens, this is typically handled using hooks.

May emit one or two {DelegateVotesChanged} events.
May emit one or two {VotesComponent-DelegateVotesChanged} events.

[.contract-item]
[[VotesComponent-num_checkpoints]]
Expand All @@ -3416,9 +3416,9 @@ Returns the `pos`-th checkpoint for `account`.

Delegates all of ``account``'s voting units to `delegatee`.

Emits a {DelegateChanged} event.
Emits a {VotesComponent-DelegateChanged} event.

May emit one or two {DelegateVotesChanged} events.
May emit one or two {VotesComponent-DelegateVotesChanged} events.

[#VotesComponent-Events]
==== Events
Expand Down

0 comments on commit cb291f3

Please sign in to comment.