Skip to content

chore(docs): fix spelling issues #3039

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/core/logger.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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';
Expand Down
2 changes: 1 addition & 1 deletion docs/utilities/parameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/utilities/parser.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/we_made_this.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 AWS Lambda Powertools to quickly build Well-Architected Serverless applications.

* [https://fourtheorem.com/aws-lambda-powertools/](https://fourtheorem.com/aws-lambda-powertools/){target="_blank"}

Expand Down