Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Fix some Natspec header comments #84

Merged
merged 1 commit into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/Governance.sol
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,8 @@ contract Governance is Multicall, UserProxyFactory, ReentrancyGuard, Ownable, IG
return max(_votes * VOTING_THRESHOLD_FACTOR / WAD, minVotes);
}

// Snapshots votes for the previous epoch and accrues funds for the current epoch
// Snapshots votes at the end of the previous epoch
// Accrues funds until the first activity of the current epoch, which are valid throughout all of the current epoch
function _snapshotVotes() internal returns (VoteSnapshot memory snapshot, GlobalState memory state) {
bool shouldUpdate;
(snapshot, state, shouldUpdate) = getTotalVotesAndState();
Expand Down
4 changes: 2 additions & 2 deletions src/utils/DoubleLinkedList.sol
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@ library DoubleLinkedList {
return list.items[0].next;
}

/// @notice Returns the item id which follows item `id`. Returns the head item id of the list if the `id` is 0.
/// @notice Returns the item id which follows item `id`. Returns the tail item id of the list if the `id` is 0.
/// @param list Linked list which contains the items
/// @param id Id of the current item
/// @return _ Id of the current item's next item
function getNext(List storage list, uint16 id) internal view returns (uint16) {
return list.items[id].next;
}

/// @notice Returns the item id which precedes item `id`. Returns the tail item id of the list if the `id` is 0.
/// @notice Returns the item id which precedes item `id`. Returns the head item id of the list if the `id` is 0.
/// @param list Linked list which contains the items
/// @param id Id of the current item
/// @return _ Id of the current item's previous item
Expand Down