diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a154482f41..c548ea5beb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -158,7 +158,7 @@ For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of ## 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. +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. ## Licensing diff --git a/docs/core/logger.md b/docs/core/logger.md index 8417e0ee0b..3e116df7b6 100644 --- a/docs/core/logger.md +++ b/docs/core/logger.md @@ -205,7 +205,7 @@ Use `POWERTOOLS_LOGGER_LOG_EVENT` environment variable to enable or disable (`tr ### Appending additional keys -You can append additional keys using either machanism: +You can append additional keys using either mechanism: * Add **extra keys** to a single log message by passing them to the log method directly * Append **temporary keys** to all future log messages via the `appendKeys()` method until `resetKeys()` is called diff --git a/docs/upgrade.md b/docs/upgrade.md index ceae97f003..f37bd461b4 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -359,7 +359,7 @@ In v2, we have removed the `ContextExamples` from the `@aws-lambda-powertools/co ## Helper functions -We removed the deprecated `createLogger` and `createTracer` heper functions. +We removed the deprecated `createLogger` and `createTracer` helper functions. ```typescript import { createLogger } from '@aws-lambda-powertools/logger'; diff --git a/docs/utilities/parameters.md b/docs/utilities/parameters.md index 3507c515f2..f0460eac42 100644 --- a/docs/utilities/parameters.md +++ b/docs/utilities/parameters.md @@ -330,7 +330,7 @@ For example, if you have three parameters, _/param/a_, _/param/b_ and _/param/c_ If you use `transform` with `getMultiple()`, you might want to retrieve and transform parameters encoded in different formats. -You can do this with a single request by using `transform: 'auto'`. This will instruct any provider to to infer its type based on the suffix and transform it accordingly. +You can do this with a single request by using `transform: 'auto'`. This will instruct any provider to infer its type based on the suffix and transform it accordingly. ???+ info `transform: 'auto'` feature is available across all providers, including the high level functions. diff --git a/docs/utilities/parser.md b/docs/utilities/parser.md index ef642cb5ff..a9fc26f3d3 100644 --- a/docs/utilities/parser.md +++ b/docs/utilities/parser.md @@ -118,7 +118,7 @@ If you want to extend a schema and transform a JSON stringified payload to an ob 1. Extend built-in `AlbSchema` using JSONStringified function to transform your payload -=== "Alb exmaple payload" +=== "ALB example payload" ```json hl_lines="26" --8<-- "examples/snippets/parser/exampleAlbPayload.json" @@ -131,7 +131,7 @@ If you want to extend a schema and transform a JSON stringified payload to an ob 1. make sure to set your schema to the correct key in the JSON payload -=== "SQS exmaple payload" +=== "SQS example payload" ```json hl_lines="6 28" --8<-- "examples/snippets/parser/exampleSqsPayload.json" @@ -280,7 +280,7 @@ We recommend to use the types provided by the parser utility. If you encounter a ## Testing your code -When testing your handler with [**parser decorator**](#parse-events) you need to use double assetion to bypass TypeScript type checking in your tests. +When testing your handler with [**parser decorator**](#parse-events) you need to use double assertion to bypass TypeScript type checking in your tests. This is useful when you want to test the handler for invalid payloads or when you want to test the error handling. If you are you use middy middleware, you don't need to do this. diff --git a/docs/we_made_this.md b/docs/we_made_this.md index b3d8f6ee0f..d8d5981b5e 100644 --- a/docs/we_made_this.md +++ b/docs/we_made_this.md @@ -47,7 +47,7 @@ Discover how easy it is to quickly “power-up” your Node.js Lambda functions > **Author: [Eoin Shanaghy](https://twitter.com/eoins){target="_blank"} :material-twitter:** -This post shows how to use AWS Lambda Powertools to quickly build Well-Architected serverless applications. +This post shows how to use Powertools for AWS Lambda to quickly build Well-Architected Serverless applications. * [https://fourtheorem.com/aws-lambda-powertools/](https://fourtheorem.com/aws-lambda-powertools/){target="_blank"}