search

cquiroz / scala-java-time

Implementation of the `java.time` API in scala. Especially useful for scala.js
http://cquiroz.github.io/scala-java-time/
BSD 3-Clause "New" or "Revised" License
126 stars 33 forks source link

documentation questions, regarding use on JVM, JS and Native #464

Open bblfish opened 1 year ago

bblfish commented 1 year ago

I was re-implementing a a.pure scala version of banana-rdf, which needs xsd dateTimestamps, and then I realised I need a pure Scala implementation for scalajs. and following links I found your project.

Your documentation states:

The scala-java-time library is currently available for Scala (JVM, version 8 and later) and Scala.js (JavaScript).

Once I noticed that you use the same java.time namespace I got a bit confused, because I wondered if one was meant to override the jvm package, and how one was meant to do that. But @sjrd mentioned that the primary use-case for this lib is not for the jvm... which makes sense, but the sentence above is a bit confusing.

So I guess this is primarily useful for scala-js and Scala-native, right? (Which is actually what I was looking for)

If so that could be made a bit clearer on the documentation page. Either that or one also needs some explanation of how one would make sure one was using your java.time or the JVM one...

cquiroz commented 1 year ago

That's right, the main reason for the jvm side is so we can do tests comparing the results to the runtime behavior of the jwm.

In reality you only want to use it on js/native.

we should update the documentation, PRs are welcome