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 chronoLocalDateTimeExpectations of api-fluent #915

Closed
5 tasks
robstoll opened this issue May 22, 2021 · 3 comments · Fixed by #935
Closed
5 tasks

add samples for chronoLocalDateTimeExpectations of api-fluent #915

robstoll opened this issue May 22, 2021 · 3 comments · Fixed by #935
Assignees
Labels
Milestone

Comments

@robstoll
Copy link
Owner

robstoll commented May 22, 2021

Code related feature

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

Following the things you need to do:

api-fluent

  • create ChronoLocalDateTimeExpectationSamples 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 chronoLocalDateTimeExpectations.kt (see AnyExpectationSamples)
    • suffix the function name for the one which expect a String with String e.g. toBeBeforeString
    • Bonus show all supported formats for the function expecting a string, mentioning the format as comment
  • refer to the sample in the KDoc of the corresponding function in chronoLocalDateTimeExpectations.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).
@dias-wagner
Copy link
Contributor

I'll work on this

@dias-wagner
Copy link
Contributor

About the bonus, you mean comments in the code?

@robstoll
Copy link
Owner Author

robstoll commented Jun 8, 2021

Something along the line of:

 // format yyyy-mm-dd time can be omitted in which case 00:00:00 is used
expect(date).toBeBefore("2021-03-01")
 // format yyyy-mm-ddThh minutes and seconds can be omitted in which case 0 is used
expect(date).toBeBefore("yyyy-mm-ddThh

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

Successfully merging a pull request may close this issue.

2 participants