lake: descriptions that need product confirmation in TiDB Cloud Lake docs

Đang mở
#24,454 1 bình luận 0 reaction 2 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@awxxxxxx đang làm issue này rồi.

Từ ngày 14/10/2026.

Đánh giá

Issue này chưa được đánh giá.

Mô tả

While reviewing the Japanese translation of the TiDB Cloud Lake docs, I found the following descriptions in the English docs (release-8.5, tidb-cloud-lake/) that look inconsistent. Fixing them needs knowledge of the actual product behavior, so I list them here instead of changing them. The clear typos and contradictions are fixed in #24452 and #24453.

# File Issue
1 sql/h3-edge-angle.md The summary and body say "Returns the average length of the H3 hexagon edge in grades", but geospatial-functions.md describes H3_EDGE_ANGLE as "Return the angle in radians between two edges".
2 sql/var-pop.md, var-samp.md, variance-pop.md, variance-samp.md Each says "Alias for COVAR_POP" or "Alias for COVAR_SAMP" (two-argument covariance), while aggregate-functions.md describes VAR_POP and VARIANCE_POP as "Population variance" with VAR_POP(height).
3 sql/unset.md The third example (around line 105) says UNSET SESSION reverts the setting "back to the session-level setting". The other examples and the level table say it reverts to the global-level or default setting.
4 sql/geospatial-functions.md Geometry constructors such as ST_MAKEGEOMPOINT and ST_POLYGON are marked "GEOGRAPHY only", although they construct GEOMETRY values.
5 sql/sql-identifiers.md Line 107 says the example highlights the "case-sensitivity by default", but the page explains that unquoted identifiers are case-insensitive by default.
6 sql/numeric-functions.md The NEG / NEGATE example is -5 → -5, which does not show negation (for example, NEG(5) → -5).
7 sql/create-stage.md "Example 3: Create External Stage with AWS IAM User" creates an IAM user and access keys in steps 1-2, but step 3 says "Use the IAM role" and the code uses ROLE_ARN and EXTERNAL_ID.
8 sql/st-geogetryfromwkb.md The page title and function name are ST_GEOGETRYFROMWKB. Is this the real function name, or a typo for ST_GEOGRAPHYFROMWKB?
9 guides/privileges.md In UDF Privileges, USAGE says "For example, copy into a stage, presign upload" and ALL says "Grants READ, WRITE privileges", which look copied from Stage Privileges.
10 sql/system-settings.md The description of enable_hive_parquet_predict_pushdown says "predict pushdown" (probably "predicate pushdown"; the setting name is unchanged). Several rows also say "maximum memory ratio in bytes".
11 guides/benchmark-data-ingestion.md The "Use the COPY INTO command" step links its SQL Script to .../snowflake/setup.sql. Is a separate copy script intended?
12 guides/load-from-local-file.md The Tutorial 2 command INSERT INTO book_db.bookcomments(title,author,date) file_format=(type=csv) has no from @_databend_load, unlike Tutorial 1.
13 guides/load-orc.md, load-tsv.md load-orc numbers its steps 1, 2, 4, 5 (no step 3). load-tsv has two "Step 4" headings ("Step 4 (Option)"), while load-parquet uses "Step 5 (Optional)".
14 guides/audit-trail.md It says "five system history tables", but the table lists three.
15 guides/authenticate-with-aws-iam-role.md Line 31 says to select Custom trust policy under Create policy. That option belongs to the Create role flow (line 57).
16 guides/support-services.md "4/7 coverage and response window for Severity 1 issues". "24/7" is likely intended, but the upstream Databend Cloud page also says "4/7". Which is correct? (Moved here from #24453.)
17 sql/create-function.md, sql/alter-function-sql.md The parameter tables list <input_param_names> and <lambda_expression>, but the syntax shown is only AS ( <input_param_types> ) RETURNS <return_type> .... Are these rows stale? (Reported by CodeRabbit on #24452.)

The Japanese docs follow the English for all of these, so fixing the English is enough; the Japanese will follow through the regular sync.

Ngôn ngữ chính
Python
Star
616
Fork
724
Merge trung bình
2 ngày 5 giờ
Pull request đã merge (30 ngày)
168

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của pingcap/docs

Tất cả issue của pingcap/docs

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.