Problem
The problem_generation.sh script and its associated Python scripts lack parameter documentation, making it difficult for new users to understand how to use them.
Tasks
Add Comments to Scripts
Add clear comments to problem_generation.sh explaining:
- Script parameters (
BASE_SEED, N_RUNS, etc.)
- Parameters for called Python scripts (
infer_split_merge.py, deduplicate_problems.py)
- The purpose of each processing step
Definition of Done
Happy Hacking! This task is part of "OceanBase Developer Carnival" event.
Problem
The
problem_generation.shscript and its associated Python scripts lack parameter documentation, making it difficult for new users to understand how to use them.Tasks
Add Comments to Scripts
Add clear comments to
problem_generation.shexplaining:BASE_SEED,N_RUNS, etc.)infer_split_merge.py,deduplicate_problems.py)Definition of Done
problem_generation.shcontains comprehensive commentsinfer_split_merge.pyparameters are documenteddeduplicate_problems.pyparameters are documentedHappy Hacking! This task is part of "OceanBase Developer Carnival" event.