Skip to content

Commit 810c948

Browse files
authored
Fix typos. Closes #35.
1 parent 3dde437 commit 810c948

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Once you run or deploy your mkdocs documentation, you will see the API Reference
140140
Lazydocs can only parse valid Google-style docstring. To prevent the generation of invalid markdown documentation, you can use the `validate` flag:
141141

142142
```bash
143-
layzdocs --validate my_package
143+
lazydocs --validate my_package
144144
```
145145

146146
This will run [pydocstyle](https://github.com/PyCQA/pydocstyle) on your docstring and cancel the generation if an issue is found.
@@ -150,7 +150,7 @@ This will run [pydocstyle](https://github.com/PyCQA/pydocstyle) on your docstrin
150150
To get the markdown documentation as console output instead of the file generation, specify `stdout` as the `output-path`:
151151

152152
```bash
153-
layzdocs --output-path=stdout my_package
153+
lazydocs --output-path=stdout my_package
154154
```
155155

156156
## Documentation
@@ -160,7 +160,7 @@ layzdocs --output-path=stdout my_package
160160
<!-- generated via typer-cli: typer src/lazydocs/_cli.py utils docs -->
161161

162162
```bash
163-
laydocs [OPTIONS] PATHS...
163+
lazydocs [OPTIONS] PATHS...
164164
```
165165

166166
**Arguments**:

0 commit comments

Comments
 (0)