Quoted string and extension nodes: manual clarification #1082
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
Closed
Octachron
reviewed
Mar 5, 2017
manual/manual/refman/exten.etex
Outdated
| Quoted strings "{foo|...|foo}" provide a different lexical syntax to | ||
| write string literals in OCaml code. They are useful to represent | ||
| strings of arbitrary content without escaping -- as long as the | ||
| delimiter you chose (here "foo") does not occur in the string itself. |
There was a problem hiding this comment.
as long as the delimiter you chose (here "foo")
I think that the wording is not optimal here: it could be read as a warning against {foo|…foo…|foo} rather than {foo|…|foo}…|foo}. Similarly, it might be worthwhile to mention that {id| delimiters do not nest and {| {| |}≡"{|"
There was a problem hiding this comment.
I replaced here "foo" with here "|foo}".
manual/manual/refman/exten.etex
Outdated
| quotes. Note that the non-extension form, for example "{sql|...|sql}", | ||
| should not be used for this purpose, as the user cannot see in the | ||
| code that this string literal has a different semantics than they | ||
| expect. |
There was a problem hiding this comment.
Another point that could eventually be mentioned here is that using the extra delimiters identifier to express semantic will interfere with their intended use case of avoiding escaping issues.
gasche
force-pushed
the
quoted-string-extension-node-manual-clarification
branch
from
b31ddf0
to
9b83b93
Compare
|
Thanks @Octachron, I amended the PR according to your advice. |
gasche
force-pushed
the
quoted-string-extension-node-manual-clarification
branch
from
9b83b93
to
dd6f4a8
Compare
This manual clarification is intended to lift up the misunderstanding that is the basis for ocaml#1066.
|
Merged in 4.05 and trunk. |
EmileTrotignon
pushed a commit
to EmileTrotignon/ocaml
that referenced
this pull request
Jan 12, 2024
* rearrange blog.eml page layout to have less boilerplate and clearer heading "OCaml Community Blog" to make it more obvious what's being shown here * change featured post to "The Journey to OCaml Multicore: Bringing Big Ideas to Life" * change featured section to not require three featured posts. Anything from 1-3 works fine. * clean up HTML and styles a bit (use h2 and h1, remove unnecessary wrapper div)
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.
This manual clarification is intended to lift up the misunderstanding
that is the basis for #1066.