Skip to content

Commit

Permalink
Fix type on require.
Browse files Browse the repository at this point in the history
  • Loading branch information
lerno committed Jan 13, 2025
1 parent c861c72 commit ef7c11a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions src/content/docs/Language Fundamentals/comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For example:
<*
Here are some docs.
@param num_foo `The number of foos.`
@required num_foo > 4
@require num_foo > 4
@deprecated
@mycustom 2
*>
Expand All @@ -36,7 +36,7 @@ void bar(int num_foo)
The following was extracted:
- The function description: *"Here are some docs."*
- The `num_foo` parameter has the description: *"The number of foos"*.
- A [Contract](/language-common/contracts/) annotation for the compiler: `@required num_foo > 4` which tells the compiler and a user of the function that a precondition is that `num_foo` must be greater than 4.
- A [Contract](/language-common/contracts/) annotation for the compiler: `@require num_foo > 4` which tells the compiler and a user of the function that a precondition is that `num_foo` must be greater than 4.
- A function [Attribute](/language-common/attributes/) marking it as `@deprecated`, which displays warnings.
- A custom function [Attribute](/language-common/attributes/) `@mycustom`. The compiler is free to silently ignore custom Attributes, they can be used to optionally emit warnings, but are otherwise ignored.

Expand Down

0 comments on commit ef7c11a

Please sign in to comment.