Skip to content

Docs: clarify Middy's role #359

Closed
@heitorlessa

Description

@heitorlessa

Description of the improvement

Summary of the proposal

Clarify whether customers need to install Middy and what its role is before sharing code snippets.

How, where did you look for information

Tracer page when looking to how to use it.

Missing or unclear documentation

The first example of Tracer make use of Middy to showcase how to use it as a middleware - This however might not be known to everyone first-hand, and this also requires them to install another dependency in order to use Powertools Tracer.

Improvement

If Middy is the preferred way throughout the docs (Middy, then Decorator, then Manual), make an explicit mention as to what Middy is, its role when using Powertools and whether it's required to follow the example.

Related existing documentation

A related issue is what seems to be an incorrect line number to highlight - I suspect you meant L10.

image

Related issues, RFCs

Metadata

Metadata

Assignees

Labels

completedThis item is complete and has been merged/shippeddocumentationImprovements or additions to documentationtracerThis item relates to the Tracer Utility

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions