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

Add missing code block language #1113

Merged
merged 1 commit into from
Dec 4, 2024
Merged

Conversation

Kyle-Ye
Copy link
Contributor

@Kyle-Ye Kyle-Ye commented Dec 4, 2024

Bug/issue #, if applicable: None

Summary

Add missing code block language to align with other parts in this file

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

  • Added tests
  • Ran the ./bin/test script and it succeeded
  • Updated documentation if necessary

Background

I was referring this doc when fixing another doc-related issue. And when I check the source content, I noticed a few missing code block is missing the language.

@Kyle-Ye Kyle-Ye requested a review from d-ronnqvist December 4, 2024 07:35
@Kyle-Ye
Copy link
Contributor Author

Kyle-Ye commented Dec 4, 2024

@swift-ci test

Copy link
Contributor

@d-ronnqvist d-ronnqvist left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI: these changes have no effect because this catalog already specifies "markdown" as the default code listing language.

That said, I still think the explicitness in the markup is worthwhile because someone who edits the documentation can see the intended code block language without needing to check the preview or look in a different file.

@Kyle-Ye Kyle-Ye merged commit 66155d8 into swiftlang:main Dec 4, 2024
2 checks passed
@Kyle-Ye Kyle-Ye deleted the optimize/format branch December 4, 2024 09:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants