Skip to content

docs(bigquery): fix uncompilable Javadoc snippets and copy-paste labels - #15122

Merged
lqiu96 merged 2 commits into
googleapis:mainfrom
lqiu96:docs/bq-0d-fix-javadoc-snippets-and-labels
Nov 20, 2026
Merged

lqiu96 merged 2 commits into
googleapis:mainfrom
lqiu96:docs/bq-0d-fix-javadoc-snippets-and-labels

Conversation

@lqiu96

@lqiu96 lqiu96 commented Nov 20, 2026 •

Copy link
Copy Markdown
Member

Fixes uncompilable Javadoc code snippets, malformed Javadoc tags, copy-pasted resource labels, and leaked internal comments across java-bigquery (Javadoc-only, no behavioral changes).

Summary of changes

  • Uncompilable snippets:
    • Dataset.java: replace curly quotes (“...”) in get and create examples with ASCII quotes.
    • InsertAllRequest.java: replace package-private new RowToInsert(...) with RowToInsert.of(...) and non-existent InsertAllRequest.builder(...) with InsertAllRequest.newBuilder(...).
    • BigQuery.java: fix mismatched/duplicate local variable names in delete(ModelId), delete(RoutineId), and getModel(ModelId), and replace the copy-pasted Table snippet on update(DatasetInfo) with a Dataset update snippet.
    • Connection.java and ConnectionImpl.java: fix malformed <pre>{ &#64;code blocks, add a missing semicolon on executeSelect, update setRequestTimeout(10L) to 10000L (ms), fix ..setUseReadAPI(true) and mismatched executeSelectFut/executeSelectFuture, replace nonexistent executeSelectRes.getBigQueryResult() with executeSelectRes.getResultSet(), and use column names ("corpus", "StringField") instead of rs.getString(1).
  • Copy-pasted labels and leaked internal comments:
    • Fix copy-pasted resource names and descriptions on BigQuery (ModelListOption, RoutineOption, JobListOption.fields, JobOption), Table.update, Model (exists, update, class Javadoc), QueryJobConfiguration.of (Copy Job -> Query Job configuration), QueryParameterValue.getRangeValues, FieldValue.getTimestampInstant ({@code String} -> {@link Instant}), and FieldValueList.get(String) (by index -> by name).
    • Remove stray // in Field.setPrecision, remove leaked (-- ... --) internal proto comments in Field.setCollation and DatasetInfo.setDefaultCollation, and replace raw Markdown triple backticks and duplicated text in RemoteFunctionOptions.

Verification

  • mvn -f java-bigquery/google-cloud-bigquery/pom.xml com.spotify.fmt:fmt-maven-plugin:check -Dlint checkstyle:check@checkstyle test-compile (0 Checkstyle violations, 0 formatting issues)
  • javadoc -Xdoclint:syntax,html,reference on all 14 modified files (0 warnings/errors)
  • Compiled all 14 modified Javadoc snippets from an external package (com.example.caller) under javac --release 8 (0 errors)

@lqiu96
lqiu96 requested review from a team as code owners November 20, 2026 23:00

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request performs a comprehensive cleanup of Javadoc comments and code examples across various classes in the google-cloud-bigquery library. Key changes include correcting inaccurate terminology (such as replacing 'table' with 'model', 'routine', or 'job' where appropriate), fixing variable names and method calls in code snippets, replacing raw HTML/markdown formatting with standard Javadoc tags like {@code}, and correcting typographical errors like curly quotes. There are no review comments to address, and the changes look excellent as they significantly improve documentation accuracy and readability.

@lqiu96
lqiu96 enabled auto-merge (squash) November 20, 2026 23:41
@lqiu96
lqiu96 merged commit 4c8b704 into googleapis:main Nov 20, 2026
198 of 199 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants