Skip to content

Conversation

inv-jishnu
Copy link
Contributor

Description

Added missing default values to the help descriptions of the following CLI arguments.
Previously, these arguments had default values defined in code, but they were not reflected in the help section, leading to incomplete information for users.

  • --data-chunk-size
  • --transaction-size
  • --split-log-mode
  • --data-chunk-queue-size

Related issues and/or PRs

NA

Changes made

  • Added missing default values to the description of the following CLI arguments in the import command options:

    • --data-chunk-size

    • --transaction-size

    • --split-log-mode

    • --data-chunk-queue-size

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • I have considered whether similar issues could occur in other products, components, or modules if this PR is for bug fixes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

NA

Release notes

Updated the import command help text to include default values for four CLI arguments.

@inv-jishnu inv-jishnu self-assigned this Oct 16, 2025
@inv-jishnu inv-jishnu requested a review from ypeckstadt October 16, 2025 11:08
Copy link
Contributor

Summary of Changes

Hello @inv-jishnu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the clarity and completeness of the import command's help documentation. It resolves an inconsistency where several CLI arguments had defined default values in the code but these were not displayed in the command's help output, ensuring users have accurate information about argument behavior.

Highlights

  • CLI Argument Descriptions: Updated the help descriptions for --data-chunk-size, --transaction-size, --split-log-mode, and --data-chunk-queue-size CLI arguments in the import command to include their default values.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

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

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 improves the CLI help text by adding default values to the descriptions of four arguments, which is a good usability improvement. However, this manual approach has some drawbacks. It's applied inconsistently, as many other arguments with default values in ImportCommandOptions.java are not updated. This also creates a maintenance issue, as the description can get out of sync with the defaultValue if it's changed in the future.

A more robust solution is to use picocli's built-in feature to display default values. By setting showDefaultValues = true on the @CommandLine.Command annotation in ImportCommand.java, picocli will automatically and consistently handle this for all options.

I recommend reverting the manual changes in this PR and adopting the automatic approach for better consistency and maintainability.

Comment on lines +136 to +137
description =
"Maximum number of records to be included in a single data chunk (default: 500)",
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

As detailed in the general feedback, manually adding the default value here is not ideal. It can lead to inconsistencies and maintenance issues. I recommend reverting this change in favor of enabling picocli's automatic default value display feature, which will handle this consistently for all options.

      description = "Maximum number of records to be included in a single data chunk",

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant