Skip to content

docs: dimensional analysis annotations#23

Merged
dadadave80 merged 2 commits into
devfrom
tob/dimensional-analysis
Apr 5, 2026
Merged

docs: dimensional analysis annotations#23
dadadave80 merged 2 commits into
devfrom
tob/dimensional-analysis

Conversation

@dadadave80
Copy link
Copy Markdown
Member

@dadadave80 dadadave80 commented Apr 5, 2026

Summary

  • Adds inline // {unit} dimensional annotations across all Solidity source files to document types (tok, s, ticket, ticketId, day, addr, BPS)
  • Adds a Dimensional Units reference section to the README

Test plan

  • Verify forge build compiles cleanly with annotations
  • Review inline comments for accuracy against contract logic

Annotate variables, parameters, and expressions with inline // {unit}
comments to document dimensional types (tok, s, ticket, ticketId, etc.)
across all contract source files.
@dadadave80 dadadave80 merged commit 80b7c10 into dev Apr 5, 2026
2 checks passed
@dadadave80 dadadave80 deleted the tob/dimensional-analysis branch April 5, 2026 16:13
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