-
Notifications
You must be signed in to change notification settings - Fork 670
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
Makes comments and formatting consistent #235
Makes comments and formatting consistent #235
Conversation
e93160f
to
ebbf21a
Compare
adef638
to
64cbdf6
Compare
Alright well I guess this is just going to get ignored. 😞 |
Hi @gigamesh sorry for not responding earlier. We'll review the PR. Thank you for the effort! |
Thank you. |
Much appreciated! |
Please don't be alarmed by the diff. None of the changes will change the bytecode.
Given the significance of EIP-4337 and how much use these contracts will receive, I thought it would be beneficial to make the comments more consistently natspec compliant and make the line lengths & indentation consistent for better readability. I tried not to be too opinionated and followed established patterns (used same @param description indentation pattern as Seaport).
Summary:
@param
descriptions@inheritdoc
for the functions that can use it but weren't already/***/
I'm happy to make any changes. And if you prefer to not merge this, no problem.
Note: I didn't touch any of the contracts in
/samples
and/test
but happy to do those as well. Also didn't add descriptions for events, errors,constructor
andreceive
functions that are missing them.