Skip to content

Commit 2a7c082

Browse files
committed
docs: address last TODOs
1 parent 1d28fd2 commit 2a7c082

File tree

3 files changed

+12
-16
lines changed

3 files changed

+12
-16
lines changed

docs/core/event_handler/api_gateway.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -669,7 +669,9 @@ This will lead to a HTTP 404 despite having your Lambda configured correctly. Se
669669
```
670670

671671
???+ note
672-
After removing a path prefix with `strip_prefixes`, the new root path will automatically be mapped to the path argument of `/`. For example, when using `strip_prefixes` value of `/pay`, there is no difference between a request path of `/pay` and `/pay/`; and the path argument would be defined as `/`.
672+
After removing a path prefix with `strip_prefixes`, the new root path will automatically be mapped to the path argument of `/`.
673+
674+
For example, when using `strip_prefixes` value of `/pay`, there is no difference between a request path of `/pay` and `/pay/`; and the path argument would be defined as `/`.
673675

674676
## Advanced
675677

@@ -738,7 +740,7 @@ This will ensure that CORS headers are always returned as part of the response w
738740
```
739741

740742
???+ tip
741-
Optionally disable class on a per path basis with `cors=False` parameter.
743+
Optionally disable CORS on a per path basis with `cors=False` parameter.
742744

743745
#### Pre-flight
744746

@@ -951,7 +953,7 @@ You can enable debug mode via `debug` param, or via `POWERTOOLS_EVENT_HANDLER_DE
951953

952954
This will enable full tracebacks errors in the response, print request and responses, and set CORS in development mode.
953955

954-
???+ warning
956+
???+ danger
955957
This might reveal sensitive information in your logs and relax CORS restrictions, use it sparingly.
956958

957959
=== "debug.py"

docs/utilities/batch.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -786,9 +786,6 @@ Inheritance is importance because we need to access message IDs and sequence num
786786

787787
Use the context manager to access a list of all returned values from your `record_handler` function.
788788

789-
##### - TODO - is this a quote or example? is the right place/ fit?
790-
> Signature: List[Tuple[Union[SuccessResponse, FailureResponse]]]
791-
792789
* **When successful**. We will include a tuple with `success`, the result of `record_handler`, and the batch record
793790
* **When failed**. We will include a tuple with `fail`, exception as a string, and the batch record
794791

docs/utilities/parameters.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -161,19 +161,16 @@ The AWS Systems Manager Parameter Store provider supports two additional argumen
161161
| **decrypt** | `False` | Will automatically decrypt the parameter.
162162
| **recursive** | `True` | For `get_multiple()` only, will fetch all parameter values recursively based on a path prefix.
163163

164-
???+ example
165-
=== "ssm_parameter_store.py"
166-
167-
```python hl_lines="6 8"
168-
from aws_lambda_powertools.utilities import parameters
164+
```python hl_lines="6 8" title="Example with get() and get_multiple()"
165+
from aws_lambda_powertools.utilities import parameters
169166

170-
ssm_provider = parameters.SSMProvider()
167+
ssm_provider = parameters.SSMProvider()
171168

172-
def handler(event, context):
173-
decrypted_value = ssm_provider.get("/my/encrypted/parameter", decrypt=True)
169+
def handler(event, context):
170+
decrypted_value = ssm_provider.get("/my/encrypted/parameter", decrypt=True)
174171

175-
no_recursive_values = ssm_provider.get_multiple("/my/path/prefix", recursive=False)
176-
```
172+
no_recursive_values = ssm_provider.get_multiple("/my/path/prefix", recursive=False)
173+
```
177174

178175
#### SecretsProvider
179176

0 commit comments

Comments
 (0)