Maintenance: Refactor and split documentation snippets to standalone python files

[heitorlessa]

Summary

We should refactor documentation snippets to improve the value new and existing customers get from them. Code snippets should be run as-is and provide what's necessary to demonstrate an utility's feature value - it might need to make an external API call to a fake API, raise Exceptions, etc.

Example of a recent work part of ~152 doc snippets refactoring: https://awslabs.github.io/aws-lambda-powertools-python/latest/core/event_handler/api_gateway/#api-gateway-rest-api

Tasks:

• Refactor Middleware factory docs code snippets #1367
• Refactor Parameters docs code snippets #1368
• Refactor Batch Processing docs code snippets #1369
• Refactor Validation docs code snippets #1370
• Refactor Parser docs code snippets #1371
• Refactor Idempotency code snippets #1372
• Refactor Feature Flags code snippets #1373
• Refactor JMESPath Functions code snippets #1374
• Refactor Typing factory docs code snippets #1453
• Revamp Data Classes utility docs to surface many unknown features #1163

Why is this needed?

Besides improving customer value, it helps us lint and enforce consistency across the documentation.

Which area does this relate to?

Middleware factory, Parameters, Batch processing, Validation, Parser, Idempotency, Feature flags, JMESPath functions

Solution

No response

Acknowledgment

• This request meets Lambda Powertools Tenets
• Should this be considered in other Lambda Powertools languages? i.e. Java, TypeScript

[leandrodamascena]

Hi @heitorlessa. Please add this issue #1453 to the task list.

[github-actions]

⚠️COMMENT VISIBILITY WARNING⚠️

This issue is now closed. Please be mindful that future comments are hard for our team to see.

If you need more assistance, please either tag a team member or open a new issue that references this one.

If you wish to keep having a conversation with other community members under this issue feel free to do so.