-
Notifications
You must be signed in to change notification settings - Fork 400
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: fix syntax errors and line highlights #1004
Conversation
Codecov Report
@@ Coverage Diff @@
## develop #1004 +/- ##
========================================
Coverage 99.96% 99.96%
========================================
Files 119 119
Lines 5347 5347
Branches 610 610
========================================
Hits 5345 5345
Partials 2 2 Continue to review full report at Codecov.
|
Besides tutorial, I wonder how this happened and how we can prevent this from happening again. Need to run git blame. Not sure if it was always there, people's markdown linter (happened before), something else entirely. Might be worth experiment with code snippets being separate Python files that can be lint - Cons is line highlights that become slightly more laborious but should pay off (--8<-) |
Importing from an actual example helps (coz you can run the some linters and auto formatting. Otherwise the line high lights suck, i wish it was different ie:
|
https://squidfunk.github.io/mkdocs-material/reference/code-blocks/ We use this in parts of the doc. Need to give a try to see if line highlights still work. If it does, then change Makefile and CI to lint them -- this will Other bits can be solved with a markdown linter. |
@heitorlessa adding #1013 in risk of this issue being closed. |
Thanks a lot again @michaelbrewer - merging it before we release it |
Issue #, if available:
Description of changes:
Checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
View rendered docs/core/event_handler/api_gateway.md
View rendered docs/tutorial/index.md