docs: fix invalid function-call example and inaccurate escape-standard reference - #6119
Open
prql-bot wants to merge 2 commits into
Open
docs: fix invalid function-call example and inaccurate escape-standard reference#6119prql-bot wants to merge 2 commits into
prql-bot wants to merge 2 commits into
Conversation
for more information, see https://pre-commit.ci
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.
Two documentation corrections found during the nightly survey of
web/book/src/reference/syntax/.1.
function-calls.md— invalid function-call example. The nested-call example used a comma to separate the inner arguments:PRQL function arguments are whitespace-separated; a comma there is a parse error (
(math.round 1, 2)fails,(math.round 1 2)compiles). The example is in aprql no-evalblock, so the doc-test harness never caught it. Removed the comma.2.
strings.md— inaccurate escape-standard reference. The text claimed strings "can contain any escape character sequences defined by the [JSON standard]", but the examples immediately below use\x48(C-style hex) and\u{01F422}(brace/6-digit) escapes — neither of which JSON defines (JSON only allows 4-digit\uXXXXand has no\x). The document's own "Escape sequences" section already, correctly, describes them as "rules similar to those used by Standard C". Changed the earlier sentence to match and to link the detailed section rather than the (incorrect) JSON reference.No regression test: both are documentation-only changes. The
function-calls.mdsnippet isno-evalby design, and thestrings.mdchange is prose.