Skip to content

LambdaStartupAttribute summary does not match documentation #2065

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

Open
474D opened this issue May 5, 2025 · 0 comments
Open

LambdaStartupAttribute summary does not match documentation #2065

474D opened this issue May 5, 2025 · 0 comments
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue pr/ready-to-merge This PR is ready to be merged.

Comments

@474D
Copy link
Contributor

474D commented May 5, 2025

Describe the issue

In the latest documentation ref: https://github.com/aws/aws-lambda-dotnet/blob/master/Libraries/src/Amazon.Lambda.Annotations/README.md

It is stated that recommended way of using LambaStartupAttribute is to use ConfigureHostBuilder
Example startup class using the recommended ConfigureHostBuilder

And for legacy cases to use ConfigureServices
For legacy support, you can still use the ConfigureServices method

In the LambdaStartupAttribute summary only the legacy way is described, ref:

/// <summary>
/// Indicates that the class will be used for registering services that 
/// can be injected into Lambda functions.
/// </summary>
/// <remarks>
/// The class should implement a ConfigureServices method that 
/// adds one or more services to an IServiceCollection.
/// </remarks>

I have attached #2064 PR with the suggested fix.

Links

https://github.com/aws/aws-lambda-dotnet/blob/master/Libraries/src/Amazon.Lambda.Annotations/LambdaStartupAttribute.cs

Lines 5-12.

@474D 474D added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels May 5, 2025
@ashishdhingra ashishdhingra added pr/ready-to-merge This PR is ready to be merged. p2 This is a standard priority issue and removed needs-triage This issue or PR still needs to be triaged. labels May 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This is a problem with documentation. p2 This is a standard priority issue pr/ready-to-merge This PR is ready to be merged.
Projects
None yet
Development

No branches or pull requests

2 participants