aws / aws/aws-lambda-go

lambda.Start documentation does not mention lambda.Handler interface

Open
#566 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
3.8k
Forks
578
Avg merge
8h 18m
Merged PRs (30d)
1

Description

Currently, the documentation for [`lambda.Start`](https://pkg.go.dev/github.com/aws/aws-lambda-go/lambda#Start) states that its parameter needs to be a function matching one of the given signatures.

However, it seems it can also accept an instance of the [`lambda.Handler`](https://pkg.go.dev/github.com/aws/aws-lambda-go/lambda#Handler) interface, as revealed by both the implementation and deprecation comment on [`lambda.StartHandler`](https://pkg.go.dev/github.com/aws/aws-lambda-go/lambda#StartHandler).

Please fix the documentation for `lambda.Start` accordingly.

I would also like to point out that deprecating `lambda.StartHandler` was a bad idea, because it means we no longer have any compile-time safety.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.