Skip to content
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

docs(idempotency) - Update invalid link target. #1588

Merged

Conversation

eldritchideen
Copy link
Contributor

@eldritchideen eldritchideen commented Oct 12, 2022

Issue number: #1443

Fixed issue reported by markdown-lint.

This issue was picked up with the Markdown lint testing, that was done as part of #1443

docs/utilities/idempotency.md:405:31 MD051/link-fragments Link fragments should be valid [Context: "[@idempotent_function decorator](#idempotentfunction-decorator)"]

Summary

Minor change to link target in Markdown for idempotency docs.

Changes

Link target in markdown. Tested via make docs-local-docker.

User experience

Clicking the link now causes the browser to jump to the correct location in the page.

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.


View rendered docs/utilities/idempotency.md

Fixed issue reported by markdown-lint.
@eldritchideen eldritchideen requested a review from a team as a code owner October 12, 2022 01:07
@eldritchideen eldritchideen requested review from rubenfonseca and removed request for a team October 12, 2022 01:08
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label Oct 12, 2022
@pull-request-size pull-request-size bot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 12, 2022
@leandrodamascena leandrodamascena changed the title docs - Update idempotency.md invalid link target. docs(idempotency) - Update invalid link target. Oct 12, 2022
@leandrodamascena
Copy link
Contributor

Hi @eldritchideen, thank you so much for opening this PR to fix this problem. A consistent documentation is one of our top priorities

This fix will be available in the next release.

@leandrodamascena leandrodamascena merged commit 99d53a7 into aws-powertools:develop Oct 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants