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.

Sign up for GitHub

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

SRC-2 Change "Panic" to "Revert" terminology #12

Merged
merged 1 commit into from
Aug 8, 2023
Merged

SRC-2 Change "Panic" to "Revert" terminology #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions standards/src_2/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,14 @@ Example:
/// * [u64] - The number of hashes performed.
```

#### - Panics
#### - Reverts

This section has a `h1` header.
Lists the cases in which the function will panic starting with the `*` symbol. The list SHALL be in the order of occurrence within the function.
Lists the cases in which the function will revert starting with the `*` symbol. The list SHALL be in the order of occurrence within the function.
Example:

```rust
/// # Panics
/// # Reverts
///
/// * When `argument_1` or `argument_2` are a zero [b256].
```
Expand Down Expand Up @@ -306,7 +306,7 @@ This standard will improve security by providing developers with relevant inform
///
/// * [bool] - Determines whether `number` is or is not 5.
///
/// # Panics
/// # Reverts
///
/// * When the sender is not the owner.
///
Expand Down