Skip to content

Commit c6e7d06

Browse files
author
Joris Conijn
committed
docs: rephrase the wording to make it more clear
1 parent d9e4180 commit c6e7d06

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,14 @@ If you discover a potential security issue in this project we ask that you notif
7171

7272
## Troubleshooting
7373

74-
* The local **API reference** throws a `Module aws_lambda_powertools not found` error when an exception is raised in the code-base, when you run `poetry run pdoc --pdf aws_lambda_powertools` the exception is shown.
74+
### API reference documentation
75+
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`.
77+
78+
This happens when:
79+
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.
7582

7683
## Licensing
7784

0 commit comments

Comments
 (0)