[fix] correct small errors in encrypt-digest, IP, JSON, and map function docs#3712
Merged
Merged
Conversation
…ion docs encrypt-digest-functions: - murmur-hash3-64-v2.md: Description typo "singed" -> "signed". - murmur-hash3-u64-v2.md: Description said the cross-reference function murmur_hash3_64_v2 is the "unsigned version"; it is the signed variant — corrected. - xxhash-32.md / xxhash-64.md: removed a self-referential Note that recommended xxhash instead of xxhash (a copy-paste leftover from the murmur docs). - murmur-hash3-64.md: list bullet "-Note:" was missing the space after the dash; corrected to "- Note:". - crc32.md: top-level sections were marked with h3 (`### Description`, `### Syntax`, ...); promoted to h2 to match sibling docs. ip-functions: - ipv6-cidr-to-range.md: the /48 mask "max" address showed only 4 `ffff` groups; corrected to 5 (`2001:db8:1:ffff:ffff:ffff:ffff:ffff`). - ipv4-cidr-to-range.md / ipv6-cidr-to-range.md: several result tables had borders narrower than their content; widened/re-aligned. - ipv6-num-to-string.md: example mentioned `::ffff:111.222.33` with only 3 IPv4 octets; corrected to `::ffff:111.222.33.44`. - ipv6-string-to-num.md: two adjacent bullets described NULL handling with the same effect; merged. - ipv6-string-to-num.md / ipv6-string-to-num-or-default.md / ipv6-string-to-num-or-null.md: frontmatter cross-referenced the inverse function as `IPv6NumToString`; normalized to the canonical `IPV6_NUM_TO_STRING` casing. - 12 ip-function files (cut-ipv6, ipv4-cidr-to-range, ipv4-string-to-num, ipv4-string-to-num-or-default, ipv4-to-ipv6, ipv6-cidr-to-range, ipv6-string-to-num, ipv6-string-to-num-or-default, is-ipv4-compat, is-ipv4-mapped, is-ipv4-string, is-ipv6-string): removed a redundant lowercase `## <func_name>` heading that sat above `## Description`. - is-ipv4-compat.md: a note referenced "RFC 4291 IPv4-Mapped IPv6 Address definition", but this doc is about IPv4-Compatible addresses; corrected. json-functions: - json-array.md: an older `## Arguments` / `## Returns` pair was duplicated by `## Parameters` / `## Return Value` further down; removed the older duplicates. - json-array-ignore-null.md: typo `ingored` -> `ignored`. - json-extract.md: result-table header showed JSON path `'$.[2]'` while the query used `'$[2]'`; header now matches the query. - json-parse.md: a Usage paragraph used the legacy `JSONB_PARSE` / `JSONB_PARSE_ERROR_TO_NULL` / `JSONB_PARSE_ERROR_TO_VALUE` prefix; renamed to the canonical `JSON_PARSE` series to match the rest of the doc. - strip-null-value.md: `CREATE TABLE my_test(id, v json)` was missing the column type for `id`; added `INT`. The same example's result block showed 5 rows but the summary said "1 row in set"; corrected to "5 rows in set". map-functions: - deduplicate-map.md: heading `## Syntaxntax` typo; corrected to `## Syntax`.
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 22 small documentation issues across the encrypt-digest, IP, JSON, and map function references. Each item below is independent.
encrypt-digest-functions
singed→signed.murmur_hash3_64_v2"the unsigned version"; it is the signed variant. Corrected.-Note:was missing the space after the dash; corrected to- Note:.### Description,### Syntax, …); promoted to h2 to match sibling docs.ip-functions
/48max address showed only 4 `ffff` groups; corrected to 5 (2001:db8:1:ffff:ffff:ffff:ffff:ffff).::ffff:111.222.33with only 3 IPv4 octets; corrected to::ffff:111.222.33.44.IPv6NumToString; normalized to the canonical casingIPV6_NUM_TO_STRING.cut-ipv6,ipv4-cidr-to-range,ipv4-string-to-num,ipv4-string-to-num-or-default,ipv4-to-ipv6,ipv6-cidr-to-range,ipv6-string-to-num,ipv6-string-to-num-or-default,is-ipv4-compat,is-ipv4-mapped,is-ipv4-string,is-ipv6-string) — removed a redundant lowercase## <func_name>heading sitting between the frontmatter and the canonical## Descriptionsection.json-functions
## Arguments/## Returnssection pair was duplicated by## Parameters/## Return Valuedirectly below; removed the older duplicates so the doc matches the sibling-doc style.ingored→ignored.'$.[2]'while the query used'$[2]'; header now matches the query.JSONB_PARSE/JSONB_PARSE_ERROR_TO_NULL/JSONB_PARSE_ERROR_TO_VALUE; renamed to the canonicalJSON_PARSEseries so the paragraph matches the rest of the doc.CREATE TABLE my_test(id, v json)example was missing the column type forid(addedINT); the example's result block showed 5 rows but the summary said "1 row in set" (corrected to "5 rows in set").map-functions
## Syntaxntaxtypo; corrected to## Syntax.Test plan