Added more elaborate explanation around dumpHook #39
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
I ran face first into this issue of not understanding what `s` in the example dump-hook was. In my naivity I *replaced* the contents of `s` with the serialization-string of my custom datatype. To avoid others from running into the same issue and foster a slightly better understanding of what happens in dumpHooks I added these two sentences.
|
Thank you for the PR! |
Happy to help! Particularly help others avoid running into the same silly issues I did |
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.
I ran face first into this issue of not understanding what
sin the example dump-hook was.In my naivity I replaced the contents of
swith the serialization-string of my custom datatype, which of course dropped serialization data.To avoid others from running into the same issue and foster a slightly better understanding of what happens in dumpHooks I added two sentences to the Readme elaborating what
sis (the currently unfinished serialization string of a given serialization) and how that needs to be appended to.