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

[TIDY FIRST] Click option defintiion organization (alphabetization) #11236

Merged
merged 2 commits into from
Jan 23, 2025

Conversation

QMalcolm
Copy link
Contributor

@QMalcolm QMalcolm commented Jan 23, 2025

Resolves #N/A because it's a tidy first

Problem

The organization of click option definitions in cli/params.py was a weird mixture of some alphabetization, new options getting added to the EOF, and grouping by feature. This mean the only way to find an option was to do a text search which was annoying. It also made it confusing as to where a new option should get added. Alphabetically? To the end of the file? Was there some similar option that the new option should be "near"?

Solution

Alphabetize the click option definitions.

Checklist

  • I have read the contributing guide and understand what's expected of me.
  • I have run this code in development, and it appears to resolve the stated issue.
  • This PR includes tests, or tests are not required or relevant for this PR.
  • This PR has no interface changes (e.g., macros, CLI, logs, JSON artifacts, config files, adapter interface, etc.) or this PR has already received feedback and approval from Product or DX.
  • This PR includes type annotations for new and modified functions.

@QMalcolm QMalcolm added Skip Changelog Skips GHA to check for changelog file tidy_first "Tidy First" incremental cleanup changes labels Jan 23, 2025
@QMalcolm QMalcolm requested a review from a team as a code owner January 23, 2025 18:21
@cla-bot cla-bot bot added the cla:yes label Jan 23, 2025
@QMalcolm
Copy link
Contributor Author

A quick way to "validate" all the options are still there is to do a text search on the old and new file for click.option(. They should have the same number of hits.

Copy link

codecov bot commented Jan 23, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.92%. Comparing base (31881d2) to head (b38d55a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #11236      +/-   ##
==========================================
- Coverage   88.93%   88.92%   -0.01%     
==========================================
  Files         187      187              
  Lines       24049    24049              
==========================================
- Hits        21388    21386       -2     
- Misses       2661     2663       +2     
Flag Coverage Δ
integration 86.31% <100.00%> (-0.01%) ⬇️
unit 62.47% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Components Coverage Δ
Unit Tests 62.47% <100.00%> (ø)
Integration Tests 86.31% <100.00%> (-0.01%) ⬇️

@QMalcolm QMalcolm merged commit 22bc1c3 into main Jan 23, 2025
73 checks passed
@QMalcolm QMalcolm deleted the qmalcolm--tidy-first-cli-params-organization branch January 23, 2025 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla:yes Skip Changelog Skips GHA to check for changelog file tidy_first "Tidy First" incremental cleanup changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants