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

add samples for resultExpectations of api-fluent #993

Closed
3 tasks
robstoll opened this issue Oct 6, 2021 · 1 comment · Fixed by #1011
Closed
3 tasks

add samples for resultExpectations of api-fluent #993

robstoll opened this issue Oct 6, 2021 · 1 comment · Fixed by #1011
Assignees
Milestone

Comments

@robstoll
Copy link
Owner

robstoll commented Oct 6, 2021

Code related feature

With this issue we want to add samples for resultExpectations of api-fluent

Following the things you need to do:

api-fluent

  • create ResultExpectationSamples in apis/fluent-en_GB/extensions/kotlin_1_3/atrium-api-fluent-en_GB-kotlin_1_3-common/src/test/kotlin/ch/tutteli/atrium/api/fluent/en_GB/kotlin_1_3/samples
    • add one function per function in resultExpectations (see ListExpectationSamples) => name the test function which narrow the subject (or in other words don't expect assertionCreator: Expect<E>.() -> Unit as parameter) ...Feature (e.g. toBeASuccessFeature) and the the other overload which expects the assertionCreator as the method itself (e.g. toBeASuccess)
    • refer to the sample in the KDoc of the corresponding function in resultExpectations 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).
@vinayak03
Copy link
Contributor

@robstoll I will work on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants