Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Lots of parameters with bad names #3

Open
mikegerber opened this issue Jan 10, 2022 · 0 comments
Open

Lots of parameters with bad names #3

mikegerber opened this issue Jan 10, 2022 · 0 comments
Assignees
@mikegerber
Labels
bug Something isn't working

Comments

@mikegerber
Copy link
Member

A lot of the click CLI parameters/variables are named *_dir, when they should be named *_file. This makes the code hard to read and the CLI help is wrong:

Usage: run-two-step-pipeline-on-single-page [OPTIONS] OCR_DIR
                                            DETECTOR_MODEL_DIR
                                            TRANSLATOR_MODEL_DIR
                                            HYPER_PARAMS_DETECTOR_DIR
                                            HYPER_PARAMS_TRANSLATOR_DIR
                                            CODE_TO_TOKEN_DETECTOR_DIR
                                            CODE_TO_TOKEN_TRANSLATOR_DIR
                                            OUT_DIR

Here, maybe OUT_DIR is actually a directory name, all others are files...
@mikegerber mikegerber self-assigned this Jan 10, 2022
@mikegerber mikegerber added the bug Something isn't working label Jan 10, 2022
mikegerber added a commit that referenced this issue Jan 11, 2022
@mikegerber
🐛 Fix variable names for run_two_step_pipeline_on_single_page()
71eba58 
File parameters were named *_dir. Rename all file parameters
accordingly. See also gh-3.
mikegerber added a commit that referenced this issue Jan 11, 2022
@mikegerber
🐛 sbb_ocr_postcorrection: Fix argument names for apply_sliding_window()
2b97611 
File parameters were named *_dir. Rename file parameters accordingly.
See also gh-3.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mikegerber mikegerber

Labels
bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@mikegerber