[fix] correct small errors in string, struct, and system function docs#3714
Merged
Conversation
string-functions:
- ascii.md: frontmatter description truncated mid-sentence; completed.
- count_substrings.md: two list items numbered 7; renumbered the second to 8.
- char.md: result-table headers showed `char('utf8', ...)` while queries used `CHAR(...)`; headers now match the queries.
- is-uuid.md: result-table header omitted the curly braces present in the query; header now includes them.
- mask-last-n.md: query used the literal `'Helloṭṛ123'` while the result header and output used `'Hello你好123'`; query aligned with the displayed result.
- parse-url.md / protocol.md: a Chinese `## 相关命令` section (with Chinese body and full-width period) in English docs; translated to `## See Also` with English body.
- position.md / repeat.md / reverse.md: a complete duplicate Description/Syntax/Parameters/Examples block was appended at the end of each file; removed.
- quote.md: contradictory escape note (claimed both `\\` -> `\\\\` and `\\\\` -> `\\`); removed the bad bullet. Also, `quote("It's a test")` showed an unescaped `'` in its result; output now shows the escaped `\\'`.
- parse-data-size.md: prose listed units up to ZB/YB but the table stops at EB; aligned prose with the table.
- hamming_distance.md / levenshtein.md: legacy frontmatter `title: …` (no `language`/`description`) updated to the standard JSON form used by sibling docs.
- auto-partition-name.md / char-length.md / cut-to-first-significant-subdomain.md / format-number.md / length.md / ngram-search.md / regexp-extract-all.md: frontmatter description was truncated mid-sentence; completed.
- regexp-count.md: typo `is n the total count` corrected; typos `paratemer` and `usr` corrected to `parameter` and `user`; quadruple backslash `[\\\\\\\\.:;]` simplified to `[\\\\.:;]`.
- regexp-extract-or-null.md: query pattern had `([[]ower:]]+)` while the error message referenced `([[:lower:]+)`; query updated to match the error.
- regexp.md: example used `REGEXP_EXTRACT(...)` instead of `REGEXP(...)`; corrected. Stray `~` on its own line after `## Description` (and leading `~ ` in the frontmatter description) removed.
- soundex.md: examples numbered 1-7 then jumped to 9; corrected to 8.
- url-decode.md / url-encode.md: result blocks were fenced as ```sql; corrected to ```text. Duplicate `## Required Parameters` heading in url-encode.md removed.
- frontmatter description references to function names without underscores (e.g. `REGEXPREPLACEONE`, `MASKLASTN`, `PARSEURL`, `CHARLENGTH`, ...) corrected to the canonical underscored form.
system-functions:
- database.md: `SELECT database(), schema()` showed both result-table headers as `database()`; second header corrected to `schema()`.
struct-functions:
- named-struct.md / struct.md / struct-element.md: frontmatter `language: "en-US"` -> `"en"`.
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.
Summary
Fixes 28 small documentation issues across the string, struct, and system function references. Each item below is independent.
string-functions
descriptionwas truncated mid-sentence; completed each.7.; renumbered the second to8..char('utf8', ...)while the queries usedCHAR(...); headers now match the queries.'Helloṭṛ123'while the result header and output used'Hello你好123'; query aligned with the displayed result.## 相关命令section (with Chinese body and full-width。) was sitting in English docs; translated to## See Alsowith English body.\\→\\\\and\\\\→\\); removed the bad bullet. Also,quote(\"It's a test\")showed'It's a test'(single quote unescaped) in the output; corrected to'It\\'s a test'.title: …only, nolanguage/description) updated to the standard JSON form used by sibling docs.is n the total countcorrected; typosparatemer/usrcorrected toparameter/user; the quadruple-backslash pattern[\\\\\\\\.:;]simplified to[\\\\.:;].([[]ower:]]+)while the error message referenced([[:lower:]+); query updated to match the error.REGEXP_EXTRACT(...)instead ofREGEXP(...); corrected. A stray~on its own line after## Description(and a leading~in the frontmatter description) removed.sql; corrected totext. url-encode.md also had a duplicate## Required Parametersheading; removed.REGEXPREPLACEONE,MASKLASTN,PARSEURL,CHARLENGTH, ...) corrected to the canonical underscored form (REGEXP_REPLACE_ONE,MASK_LAST_N,PARSE_URL,CHAR_LENGTH, ...).system-functions
SELECT database(), schema()showed both result-table headers asdatabase(); second header corrected toschema().struct-functions
language: \"en-US\"→\"en\".Test plan