Minor fixes to docs and ReconcileError message
#14
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
bluebear94
reviewed
Jun 10, 2023
| @@ -10,6 +10,8 @@ mod map; | |||
| /// | |||
| /// There are no required methods on this trait. Instead implementors should choose the `hydrate_*` | |||
| /// method which matches the automerge types they wish to hydrate. | |||
| /// | |||
| /// For example, for a Rust newtype based on `String`, implement the `hydrate_string` method, | |||
There was a problem hiding this comment.
This line should end with a colon instead of a comma.
bluebear94
reviewed
Jun 10, 2023
| @@ -936,7 +936,7 @@ pub fn reconcile_insert<R: Reconcile>( | |||
| /// Hydrate the key `inner` from inside the object `outer` | |||
| /// | |||
| /// This is useful when you are attempting to hydrate the key of an object. Imagine you have a | |||
| /// structure like this | |||
| /// structure like this, | |||
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 includes some minor changes to documentation, mostly fixing typos, but in some cases attempting to improve clarity. There is also one fix for a spelling mistake in an error message.