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(data-classes): Fix anchor tags to be lower case #288

Merged
merged 2 commits into from
Feb 15, 2021

Conversation

michaelbrewer
Copy link
Contributor

@michaelbrewer michaelbrewer commented Feb 13, 2021

Description of changes:

Anchors casing need to match what is generated in the html, which is lower case.

eg: S3 should be s3

NOTE: This does not fix the anchor links on the logger.md as the toc level is 3, and no anchor tags are generated for the following

[Service parameter](#the-service-parameter), [Inheriting Loggers](#inheriting-loggers), [Overriding Log records](#overriding-log-records), and [Logging exceptions](#logging-exceptions)

mkdocs.yml

  - toc:
      permalink: true
      toc_depth: 3

Checklist

@heitorlessa heitorlessa self-assigned this Feb 15, 2021
@heitorlessa
Copy link
Contributor

Another issue I miss having a proper strict mode - not sure if it's worth investing a few days on markdownlint custom rules + setup.

Thanks for picking up those!

@heitorlessa heitorlessa merged commit 2f840bf into aws-powertools:develop Feb 15, 2021
@heitorlessa heitorlessa added the documentation Improvements or additions to documentation label Feb 15, 2021
@michaelbrewer michaelbrewer deleted the docs-data-classes-anchor branch February 15, 2021 08:37
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants