Comments (1)
If applicable, provide details about conversion rules, gotchas and recommendations. Example
I don't know of gotchas related to Instant
. The only one that comes to mind is that instant + 1.days
is a non-calendar operation (this could be worth documenting in the plus
function), but I'd argue it's Duration
's gotcha. Instant
seems tough to use incorrectly to me. What gotchas did you have in mind?
Where appropriate, information about conversions and interactions with native types (e.g. Instant <-> Java Instant conversion)
When you have specific behavior on some platforms, you document it in the common code, makes sense; but when you have some extra interactions with platform code, you can't document them in common code (because symbols aren't resolved). If you have platform-specific documentation, in the IDE, it is either ignored (when writing common code) or replaces the common documentation. In the latter case, you have to repeat the common documentation for platforms and include platform-specific additions, which I think just isn't worth it.
If the system was a bit different and platform-specific documentation was added to the common documentation (and maybe the IDE would be smart enough to show the documentation for the platforms the project actually uses), then I agree that mentioning platform-specific converters and so on would be beneficial. Or better yet, if there was "extension documentation" along with extension functions: then we'd be able to show NSDate
conversions in the Instant
documentation for Darwin targets.
from kotlinx-datetime.
Related Issues (20)
- Consider deprecating `DateTimePeriod.plus` and `DatePeriod.plus` HOT 4
- Consider moving `Instant` and `Clock` to the standard library
- Not supported on Android 7.0? What are the minimum supported Android and IOS versions? HOT 2
- Missing methods we had before in Java HOT 3
- Unable to execute kotlin native packaging HOT 5
- Localization format HOT 1
- `LocalDateTime` to `Instant` conversion incorrect for mingwX64 target after daylight savings in `America/New_York` on 0.6.0 HOT 11
- Add a top-level description to the API reference
- Issue with R8 minification HOT 3
- Inconsistent behavior for dates on the edges of time overlaps
- The parsing API accepts non-ASCII digits
- Support WasmWasi HOT 1
- Is KMM still possible for apps that supports SDK 21? HOT 3
- Inherit the specified TimeZone when converting between Instant and LocalDateTime using toInstant and toLocalDateTime?
- How to get epoch milliseconds of start of the day in UTC? HOT 2
- What is the purpose of specifying TimeZone? HOT 2
- Add a dayOfYear option HOT 3
- The same serial descriptor name is used for several serializers
- Crash - Fatal Exception: java.lang.NoClassDefFoundError HOT 1
- Decide what to do with deprecated time zones
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from kotlinx-datetime.