-
Notifications
You must be signed in to change notification settings - Fork 490
Improve Reverse Resolver Introspection #498
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
base: staging
Are you sure you want to change the base?
Conversation
| /// 1. `L2ReverseRegistrar` on L2 chain via Unruggable Gateway | ||
| /// 2. `IStandaloneReverseRegistrar` for "default.reverse" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why the change?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The indent removal? I think the indent is weird when the docstring spans more than a couple lines.
However, I think all of the docstrings should be standardized closer to release, regarding @dev vs @notice use, formatting, etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure we can change to remove multiline indentation, i'll try to write a full style guide sometime this week. does mean we need to revert the indentation elsewhere though.
on @dev and @notice, the distinction should be:
@notice: documentation for a user of a contract, after deployment, e.g. interacting with deployed contract@dev: documentation for a user (or developer) of a contract, before deployment, e.g. working inside the codebase, utilising a library, using contract inheritance
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think for a lot of situations, that line is hard to draw. I feel like I'm just randomly picking one or the other in many situations. Increasingly, I want to use @notice for everything, and only use @dev for private functions or nerdy things like precomputed selectors and interfaceId's.
I looked through other codebases and found pretty arbitrary use of these tags.
-
This one seems okay as the
@devtells you about the internal details. -
This function is effectively private so the comment is
@dev. I didn't include@paramor@returnbecause it's just noise, as the comment already explains exactly what it's doing. -
This one looks wrong as I think that should be
@noticeat the top, and maybe the@parammoved below the large comment block. -
This one looks wrong too as the examples should probably be above, in
@notice. -
This event follows my thinking above. Simiarlly, these constants are private and technical.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
how about if @notice is for describing the functions external use, and @dev is for the internal workings?
@unruggable/gateways@namestone/ezccipandethersIVerifiableResolverto ChainReverseResolver