ASSERT-KTH / ASSERT-KTH/codrep-2019
Inconsistent description of command-line argument
- Dominant language
- Python
- Stars
- 20
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
Hi.
I found that the command line argument of a program (i.e., `your-program`) is confusing
for the following two reasons.
First, the given baseline systems (e.g., `guessSorted.py`) do not receive any arguments.
Rather, the paths of the input data files are hardwired in the baseline system code.
Second, `evaluate.py` seems to receive multiple input file directories (Line 131 of README.md),
while `your-program' is to receive a single directory (Line 91 of README.md).
Could you resolve these inconsistencies, please? (hopefully by giving more concrete examples)
Thank you.
-Shin
Contributor guide
No contributing guide indexed for this repository
Research direction
Compare README.md lines 91 and 131 with the command-line usage described for guessSorted.py, evaluate.py, and your-program. Check how the baseline input paths and input file directories are presented, then update the documentation with consistent descriptions and concrete examples for each program.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100