feat(docs/ci): add automatic formatting checks for code blocks in the Cookbook#2980
Merged
anton-trunov merged 3 commits intomainfrom May 1, 2025
Merged
feat(docs/ci): add automatic formatting checks for code blocks in the Cookbook#2980anton-trunov merged 3 commits intomainfrom
anton-trunov merged 3 commits intomainfrom
Conversation
anton-trunov
approved these changes
May 1, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
Closes #2925.
The Reference section won't need additional formatting checks because it'll be eventually generated from the well-formatted stdlib, while the Book section has way too many examples that won't pass the type checking even when wrapped in a
fun example() {}body. Not to mention abundance of vertical comment alignment and eol comments that continue on the next line.The comments part can be fixed by making them a bit more ugly, i.e., by aligning the first non-whitespace characters as opposed to
//(see my comments in #2925). But the type checking bit won't be resolved that easily, since some examples simply need to show unhandled errors or invalid syntax, at the very least so that people can Google/search for their errors in the docs.