docs: improve documentation for problem generation scripts (#9)

[pi-dal]

Summary

• Add comprehensive header comments to problem_generation.sh explaining script parameters (BASE_SEED, N_RUNS) and Python script parameters
• Add module-level docstrings to infer_split_merge.py and deduplicate_problems.py
• Add detailed help text to all argparse arguments
• Document important behavioral notes (e.g., end-exclusive range behavior for --indices)
• Add usage examples in the epilog section of deduplicate_problems.py

Files Changed

• problem_generation.sh: Added header documentation explaining the pipeline, knobs, and notes
• infer_split_merge.py: Added module docstring and comprehensive argparse documentation
• deduplicate_problems.py: Added module docstring, argparse documentation with usage examples

Motivation

The problem generation scripts lacked documentation, making it difficult for new users to understand:

• What each script parameter does
• The expected input/output formats
• Important behavioral details (e.g., end-exclusive ranges)

This change improves usability by providing inline documentation that users can access via:

• Reading the script files directly
• Running scripts with --help flag

Closes #9

[gemini-code-assist]

Summary of Changes

Hello @pi-dal, I'm Gemini Code Assist¹! 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 significantly enhances the documentation for the problem generation pipeline scripts. It introduces clear explanations for script parameters, module functionalities, and command-line arguments, making the scripts much more accessible and easier to use for both new and existing contributors. The improvements aim to reduce the learning curve and prevent common misunderstandings regarding script behavior and expected inputs/outputs.

Highlights

• Shell Script Documentation: Comprehensive header comments have been added to problem_generation.sh to explain the script's pipeline, configurable parameters (BASE_SEED, N_RUNS), and important behavioral notes.
• Module-Level Docstrings: Module-level docstrings were introduced in infer_split_merge.py and deduplicate_problems.py to provide a high-level overview of each script's purpose and expected inputs/outputs.
• Argparse Help Text Enhancement: All argparse arguments in the Python scripts now feature detailed help text, clarifying their function, expected formats, and specific behavioral nuances.
• Behavioral Notes: Important behavioral notes, such as the end-exclusive range behavior for --indices in deduplicate_problems.py, are explicitly documented within the help text and shell script comments.
• Usage Examples: Practical usage examples have been added to the epilog section of deduplicate_problems.py to guide users on how to run the script effectively.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

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. ↩

[gemini-code-assist]

Code Review

This pull request significantly improves the documentation and usability of the problem generation scripts. The addition of module-level docstrings, detailed argparse help texts, and explanatory comments in the shell script are all excellent changes that make the tools much easier to understand and use. My review includes one minor suggestion to further improve the clarity of the configuration section in problem_generation.sh.

[gemini-code-assist]

The term 'Knobs' is a bit informal and could be ambiguous. Since these values are hardcoded and need to be manually edited in the script, it would be clearer to explicitly state that they are configurable by editing the script. Consider a more descriptive header for this section to improve clarity for future users.

Suggested change

	# Knobs:
	# Configuration (edit variables below):