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

Require parse arguments #1228

Merged
merged 2 commits into from May 17, 2023
Merged

Require parse arguments #1228

merged 2 commits into from May 17, 2023

Conversation

huddlej
Copy link
Contributor

@huddlej huddlej commented May 17, 2023

Description of proposed changes

Require arguments to augur parse that are actually required including the list of fields to parse and both output files.

Related issue(s)

Resolves #1222

Testing

  • Adds a simple functional test to confirm this new behavior.
  • Checks pass

Checklist

  • Add a message in CHANGES.md summarizing the changes in this PR that are end user focused. Keep headers and formatting consistent with the rest of the file.

Require arguments to `augur parse` that are actually required including
the list of fields to parse and both output files. Adds a simple
functional test to confirm this new behavior.

Resolves #1222
@codecov
Copy link

codecov bot commented May 17, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (b696621) 68.87% compared to head (6a8bd3d) 68.87%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1228   +/-   ##
=======================================
  Coverage   68.87%   68.87%           
=======================================
  Files          64       64           
  Lines        6937     6937           
  Branches     1693     1693           
=======================================
  Hits         4778     4778           
  Misses       1854     1854           
  Partials      305      305           
Impacted Files Coverage Δ
augur/parse.py 89.41% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@huddlej huddlej merged commit 5c1fc41 into master May 17, 2023
1 of 27 checks passed
@huddlej huddlej deleted the require-parse-arguments branch May 17, 2023 20:08
@@ -2,21 +2,20 @@

## __NEXT__

### Internal
Copy link
Member

Choose a reason for hiding this comment

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

@huddlej I had put Internal there on purpose, as CI is not a bug fix. Did you remove it intentionally or during merge conflict? :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@corneliusroemer Yeah, sorry about that. I wanted to standardize the file while I was in there (I removed some newlines, too) and all of our previous CI changes have been classified as "Bug fixes" for the sake of noting the next release type. I might be overly compulsive about those things though...

Copy link
Member

Choose a reason for hiding this comment

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

Not sure how much weight I would put on precedent here, it's not like anyone has build a script to parse our change notes that would break if we add a new type of heading (I hope). Had I been aware I would have argued for the change already earlier. I have a strong opinion, but it's weakly held. Happy to leave things as is if others hold their opinions more strongly on this 🙃

Copy link
Member

@victorlin victorlin Jul 10, 2023

Choose a reason for hiding this comment

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

I'm just seeing this conversation. This codebase has (somewhat recently) adopted a practice of not including CI changes in the changelog to keep it relevant for users.

If we were to include them though, I'd be on board with you @corneliusroemer - it's better to separate CI changes from actual "bug fixes" for a similar motivation of readability for users (and developers).

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.

DOC(parse): No useful error when no --fields passed, required args not documented
3 participants