Skip to content

Maintenance: Refactor and split documentation snippets to standalone python files #1364

Closed
@heitorlessa

Description

@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:

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

Metadata

Metadata

Labels

documentationImprovements or additions to documentationhelp wantedCould use a second pair of eyes/handstech-debtTechnical Debt tasks

Type

No type

Projects

Status

Closed

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions