Skip to content

docs: improve NatSpec and clarify internal comments#1006

Open
Dark-Brain07 wants to merge 1 commit intoUniswap:mainfrom
Dark-Brain07:main
Open

docs: improve NatSpec and clarify internal comments#1006
Dark-Brain07 wants to merge 1 commit intoUniswap:mainfrom
Dark-Brain07:main

Conversation

@Dark-Brain07
Copy link

Related Issue

N/A

Description of changes

This PR improves documentation across several core files to enhance readability and maintainability.

  • PoolManager.sol: Added @dev notes to external functions to clarify event emission ordering and lock checks.
  • Lock.sol / NonzeroDeltaCount.sol: Expanded comments on ephemeral storage to explain current assembly usage vs future transient keyword support.
  • CurrencyReserves.sol: Documented storage slot derivation for better clarity.

@Dark-Brain07 Dark-Brain07 requested a review from a team as a code owner January 24, 2026 01:44
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.

1 participant