Add various updates to docs #234
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This updates the docs to include how to run
diplomat-gen.It also includes adding an example to the README and the lib.rs header. It may be worthwhile to look into unifying those in the future.
Once we have a good setup for handling
TimeZoneProviders, it may be worth while looking into includingNowinto the docs that can run in CI. For now I went with a rather simple example to show conversion ofPlainDatewith an ISO calendar to aPlainDatewith a japanese calendar.The examples are nice to see, but they do show a slight weakness in the API ergonomics that using
TemporalResultis not always ideal. I think the primary reason theTemporalResultis there is due to a fallible conversion from us -> ICU4X. But I'm not entirely sure it is 100% fallible. It would be worth confirming if we could use anexpectonas_icu4x. It would probably dramatically increase our API ergonomics.