Skip to content

Commit

Permalink
Update roles-and-directives.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisjsewell committed Jul 27, 2023
1 parent a2511b7 commit e9d4fc7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/syntax/roles-and-directives.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,14 @@ print(f'my {a}nd line')
```
:::

Comments, starting `#`, are also allowed in between options or at the end of values, and are ignored.
The values can be enclosed in quotes and span multiple lines.
Newline behaviour can be controlled by starting the value with `|` (preserve newlines) or `>` (collapse newlines):

:::{myst-example}
```{code-block} python
:lineno-start: 10
:lineno-start: 10 # this is a comment
: # this is also a comment
:emphasize-lines: "1, 3"
:caption: |
: This is my
Expand Down

0 comments on commit e9d4fc7

Please sign in to comment.