Skip to content

Commit

Permalink
Fix typos. Closes #35.
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasmasuch authored May 19, 2022
1 parent 3dde437 commit 810c948
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ Once you run or deploy your mkdocs documentation, you will see the API Reference
Lazydocs can only parse valid Google-style docstring. To prevent the generation of invalid markdown documentation, you can use the `validate` flag:

```bash
layzdocs --validate my_package
lazydocs --validate my_package
```

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

```bash
layzdocs --output-path=stdout my_package
lazydocs --output-path=stdout my_package
```

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

```bash
laydocs [OPTIONS] PATHS...
lazydocs [OPTIONS] PATHS...
```

**Arguments**:
Expand Down

0 comments on commit 810c948

Please sign in to comment.