[fix] correct table-function, table-valued-function, and SQL-statement doc errors#3715
Merged
Merged
Conversation
…t doc errors table-functions: - explode-bitmap.md: remove a stray sentence describing the outer-variant behavior in the non-outer doc. - explode-outer.md: frontmatter title was "EXPLODE-OUTER" (hyphen); corrected to "EXPLODE_OUTER". Syntax and three lateral-view examples were invoking `explode(...)` instead of `explode_outer(...)`; corrected. - explode-json-array-int-outer.md: Description said "call the `explode` function" — should be `explode_outer`. - explode-map.md: Examples 1 and 2 invoked `explode_map_outer(...)` in this non-outer doc; changed to `explode_map(...)`. - unnest.md: Example 3 result table had columns labeled `ord` / `tag` in the wrong order vs the values; header labels swapped. Also frontmatter `language: "en-US"` → `"en"`. table-valued-functions: - frontends.md: Return Value table was missing the `CurrentConnected` field; added. - numbers.md: Syntax `[, "<const_value>" = "<const_value>" ]` — the KEY should be the literal `const_value`, not a placeholder; fixed. - local.md: a stray fragment `+---+---+---+` immediately followed by an orphan closing fence; removed. - query.md: a result block was opened with a plain ``` fence (no language hint); changed to ```text for consistency with sibling docs. sql-statements: - ALTER-WORKLOAD-POLICY.md: frontmatter description and body said "Workload Group" — should be "Workload Policy". Code fence tagged as ```Java for a SQL example; corrected to ```sql. - REVOKE-FROM.md: access-control note text said "perform the GRANT operation"; corrected to "perform the REVOKE operation". - ALTER-USER.md: garbled sentence "This command give over supports modifying user roles from versions 2.0..." rewritten as "Starting from version 2.0, this command no longer supports modifying user roles..." Also two full-width pipes `|` in the PASSWORD_LOCK_TIME syntax/description replaced with ASCII `|`. - CREATE-USER.md: same full-width-pipe fix. - ALTER-WORKLOAD-GROUP.md / CREATE-WORKLOAD-GROUP.md: a full-width comma `,` in English prose replaced with ASCII `, and `. - CREATE-RESOURCE.md: parameter table heading was `1.`<type>`` but the body describes `<property>`; corrected. - ADD-BROKER.md: Syntax had `"host>:<ipc_port>"` missing the opening `<`; corrected. Two examples omitted the required `<broker_name>` argument; added. - ADD-BACKEND.md: duplicate list number `3.`; renumbered the trailing items. - DROP-USER.md: Syntax wrapped the `<user_identity>` placeholder in extra single quotes; removed for consistency with other account-management docs. - SHOW-COMPUTE-GROUPS.md: result-table header column widths were off by 1; header rows now align with the rulers.
The Example 3 result-table issue (column values/labels mismatch) cannot be fixed without confirming how Doris's unnest WITH ORDINALITY actually orders its output. The frontmatter language tweak is invisible to readers. Defer both to a separate PR where the example can be re-verified against the engine.
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 23 small documentation issues across the table-functions, table-valued-functions, and SQL-statement (account-management, cluster-management) references. Each item below is independent.
table-functions
"EXPLODE-OUTER"(hyphen); corrected to"EXPLODE_OUTER". The Syntax line and three lateral-view examples invokedexplode(...)rather thanexplode_outer(...); corrected.explode(non-outer) instead ofexplode_outer.explode_map_outer(...)in this non-outer doc; changed toexplode_map(...).ord/tagswapped vs the underlying values; header labels reordered. Also frontmatterlanguage: \"en-US\"→\"en\".table-valued-functions
CurrentConnectedfield; added.[, \"<const_value>\" = \"<const_value>\" ]placed the placeholder on the KEY side; the KEY is the literal string\"const_value\". Corrected.+---+---+---+immediately followed by an orphan closing fence; removed.fence (no language hint); changed totext for consistency with sibling docs.sql-statements
Java for a SQL example; corrected tosql.\"This command give over supports modifying user roles from versions 2.0…\"rewritten as\"Starting from version 2.0, this command no longer supports modifying user roles…\". Two full-width pipes|in thePASSWORD_LOCK_TIMEsyntax / description block replaced with ASCII|.,in English prose replaced with ASCII, and.1.\`but the immediately following text describes`; corrected.\"host>:<ipc_port>\"was missing the opening<; corrected. Two examples omitted the required<broker_name>argument; added a placeholder name.3.; renumbered the trailing items.<user_identity>placeholder in extra single quotes; removed for consistency with the other account-management docs.Test plan