Skip to content

Use self-documenting option instead of cryptic option #2487

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

Merged
merged 2 commits into from
Sep 26, 2020

Conversation

cclauss
Copy link
Member

@cclauss cclauss commented Sep 26, 2020

@mateuszz0000 Your review, please. Pretend that you do not know what -L stands for. How many keystrokes and clicks does it take to confirm the purpose of this option?

Describe your change:

  • Fix a bug

cclauss and others added 2 commits September 26, 2020 14:48
@mateuszz0000 Your review, please.  Pretend that you do not know what `-L` stands for.  How many keystrokes and clicks does it take to confirm the purpose of this option?
@l3str4nge
Copy link
Member

IMHO if you are lookin at this for the first time the L options would mean list of something (for intermediate users). Definitely your fix increase readability!

@cclauss
Copy link
Member Author

cclauss commented Sep 26, 2020

@mateuszz0000 Please review and approve the change so that I have the ability merge.

@cclauss cclauss merged commit db0db01 into master Sep 26, 2020
stokhos pushed a commit to stokhos/Python that referenced this pull request Jan 3, 2021
…2487)

* Use self-documenting option instead of cryptic option

@mateuszz0000 Your review, please.  Pretend that you do not know what `-L` stands for.  How many keystrokes and clicks does it take to confirm the purpose of this option?

* updating DIRECTORY.md

Co-authored-by: github-actions <${GITHUB_ACTOR}@users.noreply.github.com>
@dhruvmanila dhruvmanila deleted the codespell_--ignore-words-list branch October 1, 2022 06:02
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

Successfully merging this pull request may close these issues.

3 participants