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

merge: polish #1591

Merged
merged 6 commits into from
Aug 21, 2024
Merged

merge: polish #1591

merged 6 commits into from
Aug 21, 2024

Conversation

tsibley
Copy link
Member

@tsibley tsibley commented Aug 21, 2024

See commit messages.

Checklist

  • Automated checks pass
  • Check if you need to add a changelog message
  • Check if you need to add tests
  • Check if you need to update docs

Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.56%. Comparing base (d8faf01) to head (ddca760).
Report is 120 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1591      +/-   ##
==========================================
+ Coverage   70.51%   70.56%   +0.04%     
==========================================
  Files          78       78              
  Lines        8107     8119      +12     
  Branches     1966     1967       +1     
==========================================
+ Hits         5717     5729      +12     
  Misses       2100     2100              
  Partials      290      290              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@tsibley tsibley mentioned this pull request Aug 21, 2024
6 tasks
This is a small thing, really, but it's a detail that helps make error
messages more precise and thus potentially less confusing.  It's easy
enough, so take the care to do it.
Format defaults so they're formatted for the shell like would be
seen/input on the command-line by humans instead of as a Python value.
Rephrases default for argument-less --quiet flag.  Suppresses "(default:
None)" for required options.
@tsibley
Copy link
Member Author

tsibley commented Aug 21, 2024

Rebased onto latest master so linkcheck passes.

@tsibley
Copy link
Member Author

tsibley commented Aug 21, 2024

One more bit of error polishing coming in a few minutes…

Demonstrates the current (not ideal) error message.
This message in Metadata() now matches the error message for the same
condition in read_metadata(), which is a big improvement to the "say
what now??" quotient.  It seems like Metadata's _find_first()
implementation was intentionally made generic thus requiring a generic
error message, but it's only used in a single place, to find the id
column, so make it specific and thus clearer.
… error messages

The tuple(…)!r trick is cute but leaves single-item lists with a
trailing comma.
Copy link
Member

@victorlin victorlin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. Added a few non-blocking comments which would be good to address post-merge, maybe filed as new issues. I can write those up / just do it if it's easy enough.

augur/merge.py Show resolved Hide resolved
augur/merge.py Show resolved Hide resolved
@tsibley tsibley merged commit 242d67f into master Aug 21, 2024
28 checks passed
@tsibley tsibley deleted the trs/merge/polish branch August 21, 2024 20:39
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.

2 participants