Skip to content

Commit 32c0984

Browse files
committed
chore: tiny changes for readability
1 parent c6e7d06 commit 32c0984

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

Diff for: CONTRIBUTING.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,15 @@ If you discover a potential security issue in this project we ask that you notif
7373

7474
### API reference documentation
7575

76-
When you are working on the codebase and you use the local API reference documentation to preview you changes you might se the following message: `Module aws_lambda_powertools not found`.
76+
When you are working on the codebase and you use the local API reference documentation to preview your changes, you might see the following message: `Module aws_lambda_powertools not found`.
7777

7878
This happens when:
7979

80-
* You did not install the local dev environment yet. The solution for that would be running: `make dev`
81-
* Another option is that the code in the repository is raising an exception while the `pdoc` is scanning the codebase. Unfortunately this exception is not shown to you, but if you run `poetry run pdoc --pdf aws_lambda_powertools` the exception is shown and you can prevent the exception from being raised. Once resolved the documentation should load correctly again.
80+
* You did not install the local dev environment yet
81+
- You can install dev deps with `make dev` command
82+
* The code in the repository is raising an exception while the `pdoc` is scanning the codebase
83+
- Unfortunately, this exception is not shown to you, but if you run, `poetry run pdoc --pdf aws_lambda_powertools`, the exception is shown and you can prevent the exception from being raised
84+
- Once resolved the documentation should load correctly again
8285

8386
## Licensing
8487

0 commit comments

Comments
 (0)