Skip to content

Commit

Permalink
Updating conventions
Browse files Browse the repository at this point in the history
  • Loading branch information
stoobie committed May 2, 2024
1 parent 1c19a49 commit faf9b01
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions components/Starknet/modules/ROOT/pages/notational-conventions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,26 @@
| `<item>`
| Indicates user-supplied or variable values in code, commands, file paths, or other text that should be displayed in a monospace font.

| stem:[\text(string)]
| Indicates a fixed element or constant in a formula or mathematical notation.
| stem:[\text{string_in_math_notation}]
| Indicates a fixed element or constant specified in mathematical notation.

| *[item]*
| Indicates that the items enclosed in square brackets are optional.
| ...
| An ellipsis indicates that the preceding element can repeat multiple times.

| [item, ...]
a| Square brackets indicate that the enclosed items are optional. Also can indicate a range of numbers, where the enclosed items are included. For example, in [0,100], 0 and 100 are part of the specified range.

a| (item1, item2)
| Parentheses indicate a range of numbers, where the enclosed items are not included. For example, in (0,100), 0 and 100 are _not_ part of the specified range.

| item1 \| item2
| A vertical bar (\|) indicates a choice between *item1* and *item2*.

| {item1, item2}
a| +{item1, item2}+
| Curly brackets indicates a list or set of possible discrete values.

| ...
| An ellipsis indicates that the preceding element can repeat multiple times.

| /
| Indicates a division operator, or as a path separator in URLs and file paths.
| A forward slash indicates a division operator or a path separator in URLs and file paths.


|===

0 comments on commit faf9b01

Please sign in to comment.