Skip to content

add samples for optionalExpectations of api-fluent #917

@robstoll

Description

@robstoll

Code related feature

With this issue we want to add samples for optionalExpectations.kt of api-fluent

Following the things you need to do:

api-fluent

  • create OptionalExpectationSamples in apis/fluent-en_GB/atrium-api-fluent-en_GB-jvm/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/samples
  • add one function per function in optionalExpectations.kt (see ListExpectationSamples)
    • for functions having two overloads where one expects an assertionCreator in addition -- add the suffix Feature to the function name of the one not expecting assertionCreator (see ListExpectationSamples)
  • refer to the sample in the KDoc of the corresponding function in optionalExpectations.kt via @sample (check out toEqual in anyExpectations.kt to see how you have to refer to the sample)

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