Standard library documentation: fix few references #1206
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
The format and scanf modules were sometimes using `[!ref]` or
`[{!ref}]` in place of `{!ref}`. Moreover the format modules was
sometimes trying to use reference inside code block, which may be an
interesting feature request for ocamldoc/odoc, but is not currently
implemented in ocamldoc.
|
Merged, thanks! |
EmileTrotignon
pushed a commit
to EmileTrotignon/ocaml
that referenced
this pull request
Jan 12, 2024
Co-authored-by: cuihtlauac <cuihtlauac@users.noreply.github.com>
EmileTrotignon
pushed a commit
to EmileTrotignon/ocaml
that referenced
this pull request
Jan 12, 2024
This reverts commit 4ecaee7.
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.
There were few places in the standard library documentation that were using
[!ref]in lieu of{!ref}.The format module was also using references inside code blocks, which may be an interesting feature request for ocamldoc (or odoc) but is not currently supported. The first commit in this PR fixes both issues.
As a complement, the second commit in this PR fixes an inline code example that seemed to be intended as a multi-line examples.