docs: natspec and documentation improvements #41
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
0xmoebius
reviewed
Apr 9, 2024
0xmoebius
reviewed
Apr 9, 2024
0xmoebius
reviewed
Apr 9, 2024
0xmoebius
reviewed
Apr 9, 2024
| * @param _response The response being disputed. | ||
| * @param _request The request data. | ||
| * @param _response The response being disputed. | ||
| * @param _dispute The response being disputed. |
There was a problem hiding this comment.
don't know how to phrase this one
There was a problem hiding this comment.
_response desc matches the _dispute one
There was a problem hiding this comment.
Updated it to match the description of the same parameter everywhere else.
0xmoebius
reviewed
Apr 9, 2024
0xmoebius
reviewed
Apr 9, 2024
Comment on lines
+41
to
45
| * @param _voter The voter who has claimed their bond | ||
| * @param _disputeId The id of the dispute | ||
| * @param _amount The amount of tokens claimed | ||
| */ | ||
| event VoteClaimed(address _voter, bytes32 _disputeId, uint256 _amount); |
There was a problem hiding this comment.
we should've added the asset address to this event :P
Co-authored-by: moebius <[email protected]>
0xmoebius
approved these changes
Apr 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🤖 Linear
Closes OPO-639, OPO-353