Skip to content

Docs: fix inappropriate hilighted lines #1466

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

Closed
1 task done
rinfield opened this issue May 17, 2023 · 4 comments · Fixed by #1469
Closed
1 task done

Docs: fix inappropriate hilighted lines #1466

rinfield opened this issue May 17, 2023 · 4 comments · Fixed by #1469
Assignees
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation

Comments

@rinfield
Copy link

rinfield commented May 17, 2023

What were you searching in the docs?

Some highlighted lines in the sample code are inappropriate. Some are pointing to the wrong place, others to a line that does not exist.

The most obvious example is the "Example CloudWatch Logs excerpt" in Metric's "Adding metadata". It should be specified by highlighting the metadata on line 31.

Is this related to an existing documentation section?

https://awslabs.github.io/aws-lambda-powertools-typescript/latest/core/metrics/#adding-metadata

How can we improve?

Review and fix the highlighted lines in the code sample to ensure that they are correct.

Got a suggestion in mind?

No response

Acknowledgment

  • I understand the final update might be different from my proposed suggestion, or refused.
@rinfield rinfield added documentation Improvements or additions to documentation triage This item has not been triaged by a maintainer, please wait labels May 17, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented May 17, 2023

Thanks for opening your first issue here! We'll come back to you as soon as we can.
In the meantime, check out the #typescript channel on our AWS Lambda Powertools Discord: Invite link

@dreamorosi dreamorosi added discussing The issue needs to be discussed, elaborated, or refined and removed triage This item has not been triaged by a maintainer, please wait labels May 17, 2023
@dreamorosi
Copy link
Contributor

Hi @rinfield thank you for reporting this.

I will go through the docs and doublecheck the highlighted lines and report back here.

@github-actions
Copy link
Contributor

⚠️ COMMENT VISIBILITY WARNING ⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@dreamorosi dreamorosi added confirmed The scope is clear, ready for implementation and removed discussing The issue needs to be discussed, elaborated, or refined labels May 19, 2023
@github-actions github-actions bot added pending-release This item has been merged and will be released soon and removed confirmed The scope is clear, ready for implementation labels May 19, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 9, 2023

This is now released under v1.9.0 version!

@dreamorosi dreamorosi added completed This item is complete and has been merged/shipped and removed pending-release This item has been merged and will be released soon labels Jun 9, 2023
@dreamorosi dreamorosi moved this from Coming soon to Shipped in AWS Lambda Powertools for TypeScript Jun 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
completed This item is complete and has been merged/shipped documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants