Skip to content

Commit 94086bf

Browse files
authored
Update README.md
1 parent 6822ffa commit 94086bf

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ from dinosaur import Dinosaur
9898
import pytest
9999
from mktestdocs import check_docstring, get_codeblock_members
100100

101-
# This retrieves all methods/properties with a docstring.
101+
# This retrieves all methods/properties that have a docstring.
102102
members = get_codeblock_members(Dinosaur)
103103

104104
# Note the use of `__qualname__`, makes for pretty output
@@ -152,11 +152,13 @@ be passed any code blocks found in markdown files.
152152

153153
For example if you have a markdown file like this
154154

155-
This is an example REST response
155+
````markdown
156+
This is an example REST response
156157

157-
```json
158-
{"body": {"results": ["spam", "eggs"]}, "errors": []}
159-
```
158+
```json
159+
{"body": {"results": ["spam", "eggs"]}, "errors": []}
160+
```
161+
````
160162

161163
You could create a json validator that tested the example was always valid json like this
162164

0 commit comments

Comments
 (0)