From d9e4180141ae20094192725f5d8563b5de8c06d9 Mon Sep 17 00:00:00 2001 From: Joris Conijn Date: Sun, 30 Aug 2020 19:54:21 +0200 Subject: [PATCH 1/3] docs: add troubleshooting section --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 45c5e93da78..a04d74177ae 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -69,6 +69,9 @@ opensource-codeofconduct@amazon.com with any additional questions or comments. ## Security issue notifications If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue. +## Troubleshooting + +* 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. ## Licensing From c6e7d06f368019e908696e0a2d3928e521208966 Mon Sep 17 00:00:00 2001 From: Joris Conijn Date: Tue, 1 Sep 2020 10:59:59 +0200 Subject: [PATCH 2/3] docs: rephrase the wording to make it more clear --- CONTRIBUTING.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a04d74177ae..14e93f7504c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -71,7 +71,14 @@ If you discover a potential security issue in this project we ask that you notif ## Troubleshooting -* 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. +### API reference documentation + +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`. + +This happens when: + +* You did not install the local dev environment yet. The solution for that would be running: `make dev` +* 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. ## Licensing From 32c098443ae0482770a7161a7d778f50490821b5 Mon Sep 17 00:00:00 2001 From: heitorlessa Date: Tue, 1 Sep 2020 17:33:09 +0200 Subject: [PATCH 3/3] chore: tiny changes for readability --- CONTRIBUTING.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 14e93f7504c..1e330afa47b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -73,12 +73,15 @@ If you discover a potential security issue in this project we ask that you notif ### API reference documentation -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`. +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`. This happens when: -* You did not install the local dev environment yet. The solution for that would be running: `make dev` -* 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. +* You did not install the local dev environment yet + - You can install dev deps with `make dev` command +* 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 ## Licensing