fix: add doc and remove unused constant #183
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
jaypaik
approved these changes
Sep 4, 2024
jaypaik
reviewed
Sep 5, 2024
Comment on lines
+5
to
+9
| // ModuleEntity is a packed representation of a module function | ||
| // Layout: | ||
| // 0xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA________________________ // Address | ||
| // 0x________________________________________BBBBBBBB________________ // Entity ID | ||
| // 0x________________________________________________0000000000000000 // unused |
There was a problem hiding this comment.
Also maybe newline before this, and consider making this a NatSpec @dev comment?
There was a problem hiding this comment.
Oh I see that this is for ModuleEntity imported above. Is this necessary? IModularAccount already describes it.
There was a problem hiding this comment.
It's repeated in both IModularAccount and each of the type encoding / decoding libraries (ValidationConfigLib, HookConfigLib) so I added it here too.
adamegyed
force-pushed
the
adam/fix-moduleentitylib
branch
from
4d3aac3
to
c8b7e28
Compare
huaweigu
approved these changes
Sep 5, 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.
Motivation
We have some missing documentation and an unused constant.
Solution
Add the missing comment and remove the constant.