Experimental command to format code blocks embedded in docstrings #7598
Conversation
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
|
Looking in to why CI fails. |
nojaf
reviewed
Jul 4, 2025
| lineCount := currentLine + 1; | ||
| match (lines, !currentCodeBlockContents) with | ||
| | l :: rest, None -> | ||
| if String.trim l = "```rescript" then ( |
There was a problem hiding this comment.
Maybe check with a lowercase compare?
Allowing ReScript as well.
There was a problem hiding this comment.
Lowercase language identifier is the standard for tagging md code blocks. But we should probably add support for ```res as well.
There was a problem hiding this comment.
Feels more like the thing you encountered the most in the wild rather than a hard standard.
https://github.github.com/gfm/#info-string does not mention casing.
zth
force-pushed
the
tools-format-code-blocks-in-docstrings
branch
from
f7f994f to
dc2cc93
Compare
…environments in CI
rescript
@rescript/darwin-arm64
@rescript/darwin-x64
@rescript/linux-arm64
@rescript/linux-x64
@rescript/win32-x64
commit: |
|
@nojaf some tweaking left, but please do play around with it if you want! |
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.
Adds an experimental command to
toolsfor formatting ReScript code blocks in docstrings.I put it under
toolsjust because that was the easiest place to put it. Feedback gladly accepted on where to put it.I ran formatting on
Stdlib_Result.resiso you can see an example of the results easily.