Skip to content

Commit 589c19c

Browse files
authored
docs(lambda): log group docs not being rendered properly (#28871)
TSDoc for `logGroup` is not being rendered properly due to the use of `<` and `>`. This affects Vscode: ![Screenshot 2024-01-25 164442](https://github.com/aws/aws-cdk/assets/61606375/9db93b8c-dcbc-437e-8c07-a5f6b30c99b7) And `aws-cdk-lib` docs as well: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html#loggroup ![Screenshot 2024-01-25 164752](https://github.com/aws/aws-cdk/assets/61606375/a924353e-f5c2-4355-80d8-b511bb6488a3) Fixed by escaping `<` and `>` properly This is probably caused by `<` is interpreted as opening `JSX` tags by `MDX`. After fix: ![Screenshot 2024-01-25 165425](https://github.com/aws/aws-cdk/assets/61606375/c40c225b-cfac-4cf8-a102-832bc5f00213) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent efccfcb commit 589c19c

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

packages/aws-cdk-lib/aws-lambda/lib/function.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ export interface FunctionOptions extends EventInvokeConfigOptions {
477477
/**
478478
* The log group the function sends logs to.
479479
*
480-
* By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/<function name>.
480+
* By default, Lambda functions send logs to an automatically created default log group named /aws/lambda/\<function name\>.
481481
* However you cannot change the properties of this auto-created log group using the AWS CDK, e.g. you cannot set a different log retention.
482482
*
483483
* Use the `logGroup` property to create a fully customizable LogGroup ahead of time, and instruct the Lambda function to send logs to it.

0 commit comments

Comments
 (0)