-
Notifications
You must be signed in to change notification settings - Fork 465
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
Use markdown instead of ocamldoc for docblock comment #5095
Merged
Conversation
This file contains 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
`[a]` -> \`a\`
I'll squash merge once this is approved, to avoid noisy commits |
cristianoc
approved these changes
Apr 25, 2021
Some regex personal notes for posteriority:
|
bobzhang
pushed a commit
that referenced
this pull request
Apr 26, 2021
- Safe change. Just comments. - Odoc throws exception for certain snippets; this causes the editor plugin to fail to display the code block. Now we're just gonna pass through the raw markdown block to be displayed. - More familiar with the JS audience (and most other folks really). I've converted over: - `[foo]` - `@example [{...}]` and miscellaneous blocks - `ul`, `ol` - `{b boldStuff}` - `{i italicStuff}` - `{%html}` blocks - Things that don't need escape anymore, e.g. `\[\@\@module\]` - `@return` -> `**return**`. Same for `@param`, `@raise` and `@since`. - Use markdown link for `@see`. - 2 indentations instead of 4, since 4 means a code block in markdown. - Double newline for a rendered newline (markdown single newline doesn't break line in output).
bobzhang
pushed a commit
that referenced
this pull request
Jun 20, 2021
- Safe change. Just comments. - Odoc throws exception for certain snippets; this causes the editor plugin to fail to display the code block. Now we're just gonna pass through the raw markdown block to be displayed. - More familiar with the JS audience (and most other folks really). I've converted over: - `[foo]` - `@example [{...}]` and miscellaneous blocks - `ul`, `ol` - `{b boldStuff}` - `{i italicStuff}` - `{%html}` blocks - Things that don't need escape anymore, e.g. `\[\@\@module\]` - `@return` -> `**return**`. Same for `@param`, `@raise` and `@since`. - Use markdown link for `@see`. - 2 indentations instead of 4, since 4 means a code block in markdown. - Double newline for a rendered newline (markdown single newline doesn't break line in output).
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.
I've converted over:
[foo]
@example [{...}]
and miscellaneous blocksul
,ol
{b boldStuff}
{i italicStuff}
{%html}
blocks\[\@\@module\]
@return
->**return**
. Same for@param
,@raise
and@since
.@see
.