docs: Add initial README #70
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
minukmarkchoi
approved these changes
Apr 18, 2024
There was a problem hiding this comment.
hey, thanks for this detailed file - it definitely fills in the gaps and provides details into what this repo is about! Looks promising, can't wait to do a deep dive and put it to use!
Left a question about the error message that is returned when parsing fails, but it is a small subjective nitpick.
| ```ruby | ||
| # Unparsable JSON | ||
| result = json_serializer.deserialize('{"name""Max","age":29}') | ||
| result.error # == Typed::ParseError: json could not be parsed. Check for typos. |
There was a problem hiding this comment.
subjective nitpick: should acronyms like json be capitalized? JSON vs json?
There was a problem hiding this comment.
Yeah, I tend to capitalize it when referring to it in docs or comments, and use snake_case conventionally for variables. I think the error message probably should be capped, but would say that's out of scope for this PR.
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.
No description provided.