Add documentation to Date matchers #420

LeoColman · 2018-10-01T15:57:10Z

Solves #410

Work in progress for #410, this commit adds the first documentation as an example to be followed for the other methods.

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Year matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Month matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Day matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is Before" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

As discussed in this pull request, Dokka's samples, although pretty, won't work currently and will create some maintenance overhead. To fix these potential issue, this commit removes Dokka's sample and adds them directly to the documentation. Handles #410, but still a work in progress.

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is After" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is within" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

Jetbrains Kotlin Code Style Guide states that comments should have a space between // and the actual comment. This commit fixes that. More information can be found in https://kotlinlang.org/docs/reference/coding-conventions.html#formatting "Put a space after //: // This is a comment" This is the final commit that handles #410

Small bugfix in the documentation, in which there was a reference to LocalDateTime where it should be ZonedDateTime. Handles #410

Small bugfix in the documentation, in which there was a reference to an inexistent sample where it should be OffsetDateTime. Handles #410

Small bugfix in the documentation, in which there was a reference to OffsetDateTime where it should be LocalDate. Handles #410

Small bugfix in the documentation, in which there was a reference to LocalDate where it should be LocalDateTime. Handles #410

Handles #410

sksamuel · 2018-10-01T15:57:58Z

I will get to reviewing this over the next few days.

sksamuel · 2018-10-03T01:13:51Z

Comprehensive and well written 👍

* Adds documentation for LocalDate.shouldHaveSameYearAs matcher Work in progress for #410, this commit adds the first documentation as an example to be followed for the other methods. * WIP: Adds documentation to Date's Year comparison This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Year matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410 * WIP: Adds documentation to Date's Month comparison This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Month matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410 * WIP: Adds documentation to Date's Day comparison This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Day matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410 * WIP: Adds documentation to Date's before comparison This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is Before" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410 * WIP: Updates documentation to remove samples As discussed in this pull request, Dokka's samples, although pretty, won't work currently and will create some maintenance overhead. To fix these potential issue, this commit removes Dokka's sample and adds them directly to the documentation. Handles #410, but still a work in progress. * WIP: Adds documentation to Date's after comparison This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is After" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410 * WIP: Adds documentation to Date's within comparison This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is within" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410 * Formats comments to match Kotlin code style Jetbrains Kotlin Code Style Guide states that comments should have a space between // and the actual comment. This commit fixes that. More information can be found in https://kotlinlang.org/docs/reference/coding-conventions.html#formatting "Put a space after //: // This is a comment" This is the final commit that handles #410 * Fixes wrong LocalDateTime reference instead of ZonedDateTime Small bugfix in the documentation, in which there was a reference to LocalDateTime where it should be ZonedDateTime. Handles #410 * Fixes wrong samples reference instead of OffsetDateTime Small bugfix in the documentation, in which there was a reference to an inexistent sample where it should be OffsetDateTime. Handles #410 * Fixes wrong OffsetDateTime reference instead of LocalDate Small bugfix in the documentation, in which there was a reference to OffsetDateTime where it should be LocalDate. Handles #410 * Fixes wrong LocalDate reference instead of LocalDateTime Small bugfix in the documentation, in which there was a reference to LocalDate where it should be LocalDateTime. Handles #410 * Fixes type OffsetDateTimes instead of OffsetDateTime Handles #410

LeoColman added 14 commits September 14, 2018 13:54

Adds documentation for LocalDate.shouldHaveSameYearAs matcher

39fb2b3

Work in progress for #410, this commit adds the first documentation as an example to be followed for the other methods.

WIP: Adds documentation to Date's Year comparison

0b24d78

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Year matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

WIP: Adds documentation to Date's Month comparison

ed58adc

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Month matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

WIP: Adds documentation to Date's Day comparison

925650f

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the Day matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

WIP: Adds documentation to Date's before comparison

2d902ad

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is Before" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

WIP: Adds documentation to Date's after comparison

ab7563d

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is After" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

WIP: Adds documentation to Date's within comparison

45d35f4

This is a Work in Progress. DO NOT MERGE YET Some Date Matchers are missing documentation. This commit adds some documentation, for the "is within" matching of LocalDate, LocalDateTime, OffsetDateTime and ZonedDateTime Solves #410

Fixes wrong LocalDateTime reference instead of ZonedDateTime

13a1d72

Small bugfix in the documentation, in which there was a reference to LocalDateTime where it should be ZonedDateTime. Handles #410

Fixes wrong samples reference instead of OffsetDateTime

1c6ab80

Small bugfix in the documentation, in which there was a reference to an inexistent sample where it should be OffsetDateTime. Handles #410

Fixes wrong OffsetDateTime reference instead of LocalDate

8985365

Small bugfix in the documentation, in which there was a reference to OffsetDateTime where it should be LocalDate. Handles #410

Fixes wrong LocalDate reference instead of LocalDateTime

3e1f018

Small bugfix in the documentation, in which there was a reference to LocalDate where it should be LocalDateTime. Handles #410

Fixes type OffsetDateTimes instead of OffsetDateTime

050437f

Handles #410

LeoColman mentioned this pull request Oct 2, 2018

Matchers for shouldBeWithin duration #423

Merged

sksamuel merged commit 0615e04 into kotest:master Oct 3, 2018

LeoColman mentioned this pull request Nov 29, 2018

3.1.11 bugfix and small features release #489

Closed

17 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add documentation to Date matchers #420

Add documentation to Date matchers #420

LeoColman commented Oct 1, 2018

sksamuel commented Oct 1, 2018

sksamuel commented Oct 3, 2018

Add documentation to Date matchers #420

Add documentation to Date matchers #420

Conversation

LeoColman commented Oct 1, 2018

sksamuel commented Oct 1, 2018

sksamuel commented Oct 3, 2018