Skip to content
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

Make domain bound specs more visually descriptive #235

Closed
PaulRBerg opened this issue Jun 27, 2024 · 0 comments · Fixed by #239
Closed

Make domain bound specs more visually descriptive #235

PaulRBerg opened this issue Jun 27, 2024 · 0 comments · Fixed by #239
Labels
effort: medium Default level of effort. priority: 2 We will do our best to deal with this. type: docs Changes to documentation. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.

Comments

@PaulRBerg
Copy link
Owner

Context

While reviewing #212, it dawned on me that the NatSpec could be made clearer by having the domain bound specs be more visually descriptive.

Comparison Symbols

e.g. instead of:

/// - x must be less than or equal to `uMAX_SD1x18`.

Write this using the less than or equal symbol:

/// - x ≤ uMAX_SD1x18

Inclusion Symbols

Similarly, this:

/// @dev There is no overflow check because the domain of UD2x18 is a subset of SD59x18.

Could be turned into this using the inclusion relation symbol:

/// - There is no overflow check because UD2x18 ⊆ SD59x18
@PaulRBerg PaulRBerg added effort: medium Default level of effort. priority: 2 We will do our best to deal with this. type: docs Changes to documentation. work: clear Sense-categorize-respond. The relationship between cause and effect is clear. labels Jun 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort: medium Default level of effort. priority: 2 We will do our best to deal with this. type: docs Changes to documentation. work: clear Sense-categorize-respond. The relationship between cause and effect is clear.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant