Skip to content

rename withFailureHint to withHelpOnFailure #671

@robstoll

Description

@robstoll

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 that withHelpOnFailure would better state the intend.

Following the things you need to do:

logic

  • find everything containing with...FailureHint, duplicate and rename to withHelpOn...Failure
  • deprecate everything you find containing FailureHint and 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?

  • Write a comment I'll work on this if 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.
  • See Your first code contribution for guidelines.
  • Do not hesitate to ask questions here or to contact us via Atrium's slack channel if you need help
    (Invite yourself in case you do not have an account yet).

Metadata

Metadata

Assignees

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions