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

Remove ‘@throws AssertionError’ KDoc from Assertion Functions #742

Merged
merged 1 commit into from
Dec 23, 2020

Conversation

jGleitz
Copy link
Collaborator

@jGleitz jGleitz commented Dec 23, 2020

As discussed in #714, those docs where too vague to be actually helpful.

@codecov
Copy link

codecov bot commented Dec 23, 2020

Codecov Report

Merging #742 (7a83fe9) into master (3508b57) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master     #742   +/-   ##
=========================================
  Coverage     87.93%   87.93%           
  Complexity       16       16           
=========================================
  Files           936      936           
  Lines          8412     8412           
  Branches        390      390           
=========================================
  Hits           7397     7397           
  Misses          940      940           
  Partials         75       75           
Flag Coverage Δ Complexity Δ
bbc 78.73% <ø> (ø) 0.00 <ø> (ø)
bc 57.20% <ø> (ø) 0.00 <ø> (ø)
current 59.59% <ø> (ø) 0.00 <ø> (ø)
current_windows 58.02% <ø> (ø) 0.00 <ø> (ø)

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

Impacted Files Coverage Δ Complexity Δ
...h/tutteli/atrium/api/fluent/en_GB/anyAssertions.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...tutteli/atrium/api/fluent/en_GB/arrayAssertions.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...m/api/fluent/en_GB/charSequenceContainsCreators.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...nt/en_GB/charSequenceContainsCreatorsDeprecated.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...li/atrium/api/fluent/en_GB/collectionAssertions.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...li/atrium/api/fluent/en_GB/comparableAssertions.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...tteli/atrium/api/fluent/en_GB/featureAssertions.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
.../tutteli/atrium/api/fluent/en_GB/fun0Assertions.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...teli/atrium/api/fluent/en_GB/iterableAssertions.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
...fluent/en_GB/iterableContainsInAnyOrderCreators.kt 100.00% <ø> (ø) 0.00 <0.00> (ø)
... and 69 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3508b57...831d279. Read the comment docs.

@jGleitz jGleitz force-pushed the remove-throws branch 2 times, most recently from 7756d17 to 067410d Compare December 23, 2020 16:04
Copy link
Owner

@robstoll robstoll left a comment

Choose a reason for hiding this comment

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

@jGleitz I change my mind, sorry. I prefer if this commit does not contain changes to deprecated APIs, I am going to remove them in v0.16.0. Can you please revert those changes

@jGleitz
Copy link
Collaborator Author

jGleitz commented Dec 23, 2020

Is it a problem if this does contain changes to deprecated APIs? I did all changes with search + replace. While it’s easy to roll that back for files of deprecated projects, finding all deprecated methods would be a lot of manual work.

If those functions will be deleted anyway, why does it matter if we change them in this PR?

@robstoll
Copy link
Owner

It is enough to revert all changes in path misc/deprecated, you don't need to search for methods in api-fluent or api-infix.
I prefer to have a clean history for traceability purposes. The changes to the deprecated API is just noise in this case.

@jGleitz
Copy link
Collaborator Author

jGleitz commented Dec 23, 2020

sure, no problem! Done.

@robstoll
Copy link
Owner

Fixed the problems myself. Thanks for the PR 🙂, looking forward to the others

@robstoll robstoll merged commit 2276b4d into master Dec 23, 2020
@robstoll robstoll added this to the 0.16.0 milestone Dec 23, 2020
@jGleitz jGleitz deleted the remove-throws branch December 23, 2020 20:52
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