typelevel / typelevel/doobie

mention import of doobie.implicits.javatime._ in documentation

Open
#1,397 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Scala
Stars
2.2k
Forks
379
Avg merge
14m
Merged PRs (30d)
8

Description

I started out with the documentation for custom mappings which mentioned support for Java's OffsetDateTime and ZonedDateTime out of the box but I had to go to stackoverflow to find the right import for these implicits (import doobie.implicits.javatime._)

The FAQ's mention import doobie.implicits.javatimedrivernative._ but a) this is only available since 0.12 and b) this hint shouldn't only be in the FAQs anyway.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the custom mappings documentation and the FAQ sections mentioned in the issue, then compare how Java time support and imports are described. Done means the documentation identifies doobie.implicits.javatime._ in the relevant guidance and explains the javatimedrivernative import's version limitation.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.