rename withFailureHint to withHelpOnFailure #671
Comments
robstoll
added
enhancement
help wanted
good first issue
|
I'll work on this |
|
@robstoll I am new to Open source. I have one query do I need to open each and every file in this project and check if it contains withFailureHint method and then refactor it or is there any other way I need to proceed. |
|
Upfront, it's up to you how you do it. I think your approach is good but better search for |
|
@robstoll I am not able to do that sorry |
|
@rishujam no worries. Let me know in case you would still like to do it but need more help. |
|
I'd like to work on this issue. |
|
hey, can you assign me that issue. |
|
@offgridauthor are you still working on this one? @DurveshKumarPal would like to take over |
|
@DurveshKumarPal there are also other issues where we could use your help and are not assigned yet in case you already want to start programming: |
Go for it. Things have shifted and I won't be able to tackle this right now. |
|
I'll work on this. I am familiarizing myself with Atrium still, but I think I get the idea. I will let you know when I have questions - thanks for the chance to let me get my feet wet with contributing! |
…robstoll#671 Update `assertions/builders/descriptiveWithFailureHint.kt`: - Add `withHelpOnFailure` and mark `withFailureHint` as deprecated - Add `withHelpOnFailureBasedOnSubject` and mark `withFailureHintBasedOnSubject` as deprecated - Add `withHelpOnFailureBasedOnDefinedSubject` and mark `withFailureHintBasedOnDefinedSubject` as deprecated Update `atrium/logic/creating/filesystem/hints/hints.kt`: - Add `withHelpOnIOExceptionFailure` and mark `withIOExceptionFailureHint` as deprecated - Add `withHelpOnFileAttributesFailure` and mark `withFileAttributesFailureHint` as deprecated Refactor all usages of `with*FailureHint` found to favor the `withHelpOn*Failure` version Update `assertions/builders/DescriptiveWithBasedOnSubjectSpec.kt`: - Refactor text referencing deprecated methods Update `atrium/logic/impl/DefaultFloatingPointAssertions.kt`: - Remove unused import for deprecated `with*FailureHint` method(s) Update `atrium/logic/impl/DefaultBigDecimalAssertions.kt`: - Remove unused import for deprecated `with*FailureHint` method(s) Update `atrium/logic/impl/DefaultPathAssertions.kt`: - Remove unused import for deprecated `with*FailureHint` method(s)
|
Hey @robstoll - let me know if this commit aligns with what the ask is on this one. Thanks in advance. |
|
@stevenlmcgraw can you please create a draft PR, it's way easier go give feedback this way |
…l#671-rename-withFailureHint
|
@robstoll the draft pull request has been issued. |
Platform (all, jvm, js, android): all
Extension (none, kotlin 1.3): none
Code related feature
Currently one can create hints in case of an assertion failure by using
withFailureHint. In robstoll/atrium-roadmap#9 we came to the conclusion thatwithHelpOnFailurewould better state the intend.Following the things you need to do:
logic
with...FailureHint, duplicate and rename towithHelpOn...FailureFailureHintand point to the new functionality, i.e add a@Deprecated("Use ...; will be removed with 1.0.0")and replace...accordingly.API
there shouldn't be any change in the APIs
Your first contribution?
I'll work on thisif you would like to take this issue over.This way we get the chance to revise the description in case things have changed in the meantime, we might give you additional hints and we can assign the task to you, so that others do not start as well.
(Invite yourself in case you do not have an account yet).
The text was updated successfully, but these errors were encountered: