Skip to content

LambdaStartupAttribute summary does not match documentation #2065

@474D

Description

@474D

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationThis is a problem with documentation.p2This is a standard priority issuepr/ready-to-mergeThis PR is ready to be merged.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions