Skip to content

Commit

Permalink
Merge pull request #65 from FuelLabs/SwayStar123-patch-3
Browse files Browse the repository at this point in the history
Add allowance for additional sections in SRC2 standard
  • Loading branch information
SwayStar123 authored Mar 24, 2024
2 parents b6f76e1 + da7a9ac commit 376c92a
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion standards/src2-inline-docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,17 @@ Example:
/// This configurable variable makes security assumptions.
```

## Other Sections

If the above described sections are not relevant for the information that needs to documented, a custom section with a arbitrary `h1` header may be utilized.

Example:
```
/// # Recommended Message Style
///
/// We recommend that `expect` messages are used to describe the reason you *expect* the `Option` should be `Some`.
```

# Rationale

The SRC-2 standard should help provide developers with an easy way to both quickly write inline documentation and get up to speed on other developers' code. This standard in combination with Fuel's VS Code extension provides readily accessible information on functions, structs, and enums
Expand Down Expand Up @@ -398,4 +409,4 @@ configurable {
/// The threshold required for activation.
THRESHOLD: u64 = 5,
}
```
```

0 comments on commit 376c92a

Please sign in to comment.