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

Raise TypeError in Livecheck DSL methods, expand tests, improve documentation comments #8253

Merged
merged 3 commits into from Aug 10, 2020
Merged

Raise TypeError in Livecheck DSL methods, expand tests, improve documentation comments #8253

merged 3 commits into from Aug 10, 2020

Conversation

samford
Copy link
Member

@samford samford commented Aug 7, 2020

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew style with your changes locally?
  • Have you successfully run brew tests with your changes locally?

This adds raise TypeError logic to the Livecheck DSL methods when an invalid argument type is provided. This change brings the existing methods in line with the #strategy method added in #8156. Relevant tests have been added as well.

This also makes some changes to the existing tests for the Livecheck DSL, to better test the methods.

Past that, this reworks the documentation comments a bit and adds @param/@return information.

We previously added `raise TypeError` logic to the `Livecheck` DSL's
`#strategy` method. This updates the existing methods to follow suit
and modifies the tests accordingly.
@samford
Copy link
Member Author

samford commented Aug 7, 2020

Failed examples:

rspec ./test/utils/github_spec.rb:7 # GitHub::search_code queries GitHub code with the passed parameters

1969 examples, 1 failure, 4 pendings

brew tests worked fine locally, so I'll run CI again after awhile.

Edit: Everything passes after running this again, so it appeared to be an intermittent failure.

@MikeMcQuaid MikeMcQuaid merged commit 15fec09 into Homebrew:master Aug 10, 2020
@MikeMcQuaid
Copy link
Member

Makes sense, thanks again @samford!

@samford samford deleted the livecheck-dsl-add-raise-update-docs-comments branch August 10, 2020 12:47
@BrewTestBot BrewTestBot added the outdated PR was locked due to age label Dec 19, 2020
@Homebrew Homebrew locked as resolved and limited conversation to collaborators Dec 19, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated PR was locked due to age
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants