Skip to content

Commit

Permalink
docs: Copy-edit (attribute -> option, etc.)
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Jan 18, 2022
1 parent b072c41 commit 0e52595
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Use:
Where:

- The ``workedexample`` directive is used at the top of a section to mark the content as a worked example. Use the ``tags`` attribute to indicate the content this worked example is referring to. Multiple values are allowed by using comma-separated values. Its argument is used as the text of the hyperlink rendered by the ``workedexamplelist`` directive.
- The ``workedexample`` directive is used at the top of a section to mark the content as a worked example. Its argument is used as the text of the hyperlink rendered by the ``workedexamplelist`` directive. Tag the worked example with one or more comma-separated tags, using the ``tags`` option.
- The ``workedexamplelist`` directive is used to list all the worked examples tagged with the specified ``tag``.

To render:
Expand Down

0 comments on commit 0e52595

Please sign in to comment.