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.

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

Improving shortname handling of --addons flag #3339

Closed
amandakys opened this issue Nov 24, 2023 · 1 comment · Fixed by #3363
Closed

Improving shortname handling of --addons flag #3339

amandakys opened this issue Nov 24, 2023 · 1 comment · Fixed by #3363
Assignees
Labels
Bug Bash 🐛 Issue: Feature Request New feature or improvement to existing feature

Comments

@amandakys
Copy link

Description

The shortnames we've allocated for the add ons fluctuate on whether they are plural or not. log vs logs, test vs tests.

At the moment the short names are: log,test,lint,data,docs,viz. But many engineers instinctively think of logs rather than log and tests rather than test. However, lints doesn't work. etc

Having discussed with @AhdraMeraliQB @noklam we weren't able to find a consistent rule to apply across all the options.

Proposal:
either

  1. accept both options i.e. both --addons=log and --addons=logs will work to select the logging addon
  2. implement smarter error messages i.e. if the user types logs but its meant to be log we error Did you mean --addons=log to help them realise their mistake. Same for tests and test
@amandakys amandakys added Issue: Feature Request New feature or improvement to existing feature Bug Bash 🐛 labels Nov 24, 2023
@merelcht merelcht moved this to To Do in Kedro Framework Nov 27, 2023
@merelcht merelcht self-assigned this Nov 27, 2023
@merelcht merelcht moved this from To Do to In Progress in Kedro Framework Nov 29, 2023
@merelcht merelcht moved this from In Progress to In Review in Kedro Framework Nov 29, 2023
@merelcht merelcht linked a pull request Nov 29, 2023 that will close this issue
7 tasks
@merelcht
Copy link
Member

merelcht commented Dec 6, 2023

Completed in #3363

@merelcht merelcht closed this as completed Dec 6, 2023
@github-project-automation github-project-automation bot moved this from In Review to Done in Kedro Framework Dec 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Bash 🐛 Issue: Feature Request New feature or improvement to existing feature
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants