[fix] correct cluster-management, data-governance, load/query/database/function statement doc errors#3716
Merged
Conversation
…e/function statement doc errors cluster-management: - MODIFY-BACKEND.md: Chinese table header `属性`/`影响` -> `Property`/`Effect` in the English doc. - MODIFY-FRONTEND-HOSTNAME.md: typo `NOD_PRIV` -> `NODE_PRIV`. - ADD-FOLLOWER.md / ADD-OBSERVER.md / DROP-FOLLOWER.md / DROP-OBSERVER.md: a usage note read `use[`SHOW FRONTENDS`](./SHOW-FRONTENDS.md)command` with no spaces around the markdown link; DROP-FOLLOWER also dropped the verb "use". Sentences rewritten with proper spacing. - DROP-BROKER.md: SQL example ended with `.` instead of `;`. - ALTER-STORAGE-POLICY.md: typo `PROPERTIE` -> `PROPERTIES` in syntax and inline reference. - ALTER-STORAGE-VAULT.md: text said the listed property fields were "prohibited" when describing the hdfs type; corrected to "allowed". - CREATE-STORAGE-POLICY.md: SQL syntax contained full-width `,` and `|` Unicode characters; replaced with ASCII. - CANCEL-WARM-UP.md: syntax requires `JOB` but the example omitted it; example aligned with syntax. - SHOW-CACHE-HOTSPOT.md: a `:::info` admonition was unclosed (the closing `:::` was missing before the next `## Syntax` heading). data-governance: - CREATE-ROW-POLICY.md: frontmatter description and body Description said "Explain can view the rewritten execution plan." (leftover from the EXPLAIN doc); rewritten to actually describe row policies. - CREATE-ROW-POLICY.md: two example CREATE statements used the same policy name `test_row_policy_3`; renamed the second to `test_row_policy_4`. - CREATE-SQL_BLOCK_RULE.md: example creates `test_rule`, but the error message echoed `order_analysis_rule`; corrected. - SHOW-SQL_BLOCK_RULE.md: stray `|` at the end of a parameter description line; result tables also had misaligned borders. Cleaned up. DML / load-and-export / data-query / database / function: - MERGE-INTO.md: heading `### Duplicate join behavior¶` ended with a stray pilcrow; removed. - SHOW-LAST-INSERT.md: keywords line `SHOW, LASR ,INSERT` typo corrected to `SHOW, LAST, INSERT`. Section markers `grammar:` / `illustrate:` updated to canonical `## Syntax` / `## Return Value` headings. - CREATE-ROUTINE-LOAD.md: a frontmatter link pointed at a non-existent anchor `#Example-of-importing-Json-format-data`; corrected to the actual anchor (`#import-examples` for current / 3.x / 4.x, `#load-example` for 2.1). Frontmatter description had been truncated mid-sentence; completed. - ALTER-ROUTINE-LOAD.md / PAUSE-ROUTINE-LOAD.md / RESUME-ROUTINE-LOAD.md / STOP-ROUTINE-LOAD.md / SHOW-CREATE-ROUTINE-LOAD.md: each file's access-control table said "SHOW ROUTINE LOAD requires…" regardless of the actual statement; replaced with the matching statement name in each file. - CANCEL-LOAD.md: STATE parameter list included `FINISHED`/`CANCELLED`, but the syntax + notes only allow `PENDING`/`ETL`/`LOADING`; removed the invalid values. An example used `LABEL like "example_"` which (without `%`) won't actually match anything containing `example_`; changed to `"%example_%"` to match the prose intent. - SHOW-LOAD.md: prose said `LOAD = "PENDING"` where it should say `STATE = "PENDING"`. - SELECT.md: typo `JOIN Exampel` -> `JOIN Example`; truncated `ome additional knowledge` -> `Some additional knowledge`; invalid SQL `ORDER by LIMIT 10` -> `ORDER BY a LIMIT 10`; renumbered a duplicated list item `2.`. - SHOW-DATABASES.md: Chinese heading `## 示例` in the English doc -> `## Examples`. - SHOW-DATABASE-ID.md: `### Description` (h3) -> `## Description` (h2), matching the convention used by sibling docs. - DROP-FUNCTION.md: syntax `DROP [ GLOBAL ] <function_name>(...)` was missing the `FUNCTION` keyword.
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 25 small documentation issues across cluster-management, data-governance, DML, load-and-export, data-query, database, and function SQL-statement docs. Each item below is independent.
cluster-management
属性/影响were Chinese in the English doc; replaced withProperty/Effect.NOD_PRIV→NODE_PRIV.use[\SHOW FRONTENDS`](./SHOW-FRONTENDS.md)command` with no spaces around the markdown link; DROP-FOLLOWER also dropped the verb "use". Rewritten with proper spacing..instead of;.PROPERTIE→PROPERTIESin the syntax block and the inline reference.,and|characters; replaced with ASCII.JOBkeyword but the example omitted it; example aligned with syntax.:::infoadmonition was unclosed (no:::before the next## Syntax).data-governance
descriptionand the body Description paragraph said "Explain can view the rewritten execution plan." (a leftover from the EXPLAIN doc); rewritten to actually describe row policies.CREATE ROW POLICYstatements used the same nametest_row_policy_3; renamed the second totest_row_policy_4.test_rule, but the simulated error message echoedorder_analysis_rule; corrected.|at the end of a parameter-description line; two result tables also had misaligned borders.DML / load-and-export / data-query / database / function
### Duplicate join behavior¶ended with a stray pilcrow¶; removed.SHOW, LASR ,INSERTtypo corrected toSHOW, LAST, INSERT. Informal section markersgrammar:/illustrate:replaced with canonical## Syntax/## Return Valueheadings.#Example-of-importing-Json-format-data; corrected to the actual anchor in each version (#import-examplesfor current / 3.x / 4.x;#load-examplefor 2.1). Frontmatterdescriptionwas truncated mid-sentence; completed.FINISHED/CANCELLED, but the syntax + notes only allowPENDING/ETL/LOADING; removed the invalid values. An example usedLABEL like "example_"which, without%, doesn't match anything containingexample_; changed to"%example_%"to match the prose intent.LOAD = "PENDING"where it should saySTATE = "PENDING".JOIN Exampel→JOIN Example; truncatedome additional knowledge→Some additional knowledge; invalid SQLORDER by LIMIT 10→ORDER BY a LIMIT 10; renumbered a duplicated list item2..## 示例in the English doc →## Examples.### Description(h3) →## Description(h2), matching the convention used by sibling docs.DROP [ GLOBAL ] <function_name>(...)was missing theFUNCTIONkeyword.Test plan