Update ixdtf crate documentation #4866
Merged
Conversation
This file contains 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
nekevss
force-pushed
the
update-ixdtf-docs
branch
2 times, most recently
from
1b02047
to
df9ee56
Compare
sffc
reviewed
May 16, 2024
utils/ixdtf/src/lib.rs
Outdated
| //! (3) shows an unknown key-value annotation. In this situation, the annotation | ||
| //! ##### Example 3 | ||
| //! | ||
| //! This example shows an unknown key-value annotation. In this situation, the annotation |
There was a problem hiding this comment.
Example 3 is
//! - (3) `2024-03-02T08:48:00-05:00[u-ca=iso8601][!u-ca=iso8601]`
which is inconsistent with this text.
sffc
reviewed
May 16, 2024
utils/ixdtf/src/lib.rs
Outdated
| //! | ||
| //! let _ = IxdtfParser::new(example_with_custom_key).parse_with_annotation_handler(|annotation| { | ||
| //! if annotation.key == "answer-to-universe" { | ||
| //! answer = Some(annotation); |
There was a problem hiding this comment.
Suggestion: since this is supposed to show you how to write one of these handlers correctly, please use get_or_insert to retain the first value. Alternatively, implement the additional logic involving mismatched critical annotations.
nekevss
force-pushed
the
update-ixdtf-docs
branch
from
df9ee56
to
a756354
Compare
sffc
approved these changes
May 17, 2024
nekevss
force-pushed
the
update-ixdtf-docs
branch
from
a756354
to
6b60eb4
Compare
|
@nekevss Prefer using merge commits over rebases because it makes it harder to track changes, and the individual commits will be squashed anyway when landing on the main branch. |
|
@sffc Sounds good. Will do on future any future PRs. |
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 PR cleans up the crate docs and README for
ixdtf.The changes consist of: