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

Consistency of option names #122

Closed
dcastro opened this issue Jul 22, 2022 · 1 comment
Closed

Consistency of option names #122

dcastro opened this issue Jul 22, 2022 · 1 comment

Comments

@dcastro
Copy link
Member

dcastro commented Jul 22, 2022

Clarification and motivation

BLOCKED BY #118

The naming scheme we used for config options / command-line options seems to be somewhat inconsistent. We often use the imperative mood (e.g. ignoreRefs, checkLocalHost, ignoreAuthFailures), but sometimes use the past tense (e.g. ignored, notScanned).

We should use a consistent naming scheme.

In #118 (comment) I suggested deleting ignored and having only notScanned. If we do that, then we can rename notScanned to ignore, which would solve this issue.

If we end up going in a different direction in #118, then we should have a discussion about how to rename these two options.

Acceptance criteria

We consistently use the imperative mood when naming config options / command-line options.

@dcastro
Copy link
Member Author

dcastro commented Sep 25, 2022

This will be addressed in #171

@dcastro dcastro closed this as completed Sep 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant