Skip to content

Conversation

@adraffy
Copy link
Member

@adraffy adraffy commented Oct 22, 2025

  • bumped @unruggable/gateways @namestone/ezccip and ethers
  • expanded INameReverser — now sufficient to identify a "reverse" resolver
  • added IVerifiableResolver to ChainReverseResolver
  • reduced some duplicated constants
  • added fuzz test

@adraffy adraffy requested a review from TateB October 22, 2025 21:40
Comment on lines +19 to +20
/// 1. `L2ReverseRegistrar` on L2 chain via Unruggable Gateway
/// 2. `IStandaloneReverseRegistrar` for "default.reverse"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why the change?

Copy link
Member Author

@adraffy adraffy Nov 3, 2025

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.

Copy link
Member

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

Copy link
Member Author

@adraffy adraffy Nov 3, 2025

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 @dev tells you about the internal details.

  • This function is effectively private so the comment is @dev. I didn't include @param or @return because it's just noise, as the comment already explains exactly what it's doing.

  • This one looks wrong as I think that should be @notice at the top, and maybe the @param moved 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.

Copy link
Member

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants