docs(lambda): log group docs not being rendered properly #28871
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
repeat-contributor
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
Vandita2020
pushed a commit
to Vandita2020/aws-cdk
that referenced
this pull request
Jan 30, 2024
TSDoc for `logGroup` is not being rendered properly due to the use of `<` and `>`. This affects Vscode:  And `aws-cdk-lib` docs as well: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html#loggroup  Fixed by escaping `<` and `>` properly This is probably caused by `<` is interpreted as opening `JSX` tags by `MDX`. After fix:  ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
SankyRed
pushed a commit
that referenced
this pull request
Feb 8, 2024
TSDoc for `logGroup` is not being rendered properly due to the use of `<` and `>`. This affects Vscode:  And `aws-cdk-lib` docs as well: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html#loggroup  Fixed by escaping `<` and `>` properly This is probably caused by `<` is interpreted as opening `JSX` tags by `MDX`. After fix:  ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
TSDoc for
logGroupis not being rendered properly due to the use of<and>.This affects Vscode:
And
aws-cdk-libdocs as well: https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_lambda.Function.html#loggroupFixed by escaping
<and>properlyThis is probably caused by
<is interpreted as openingJSXtags byMDX.After fix:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license