2.x Document post serialization#2335
Merged
jarednova merged 4 commits into2.x-docs-apifrom Oct 9, 2020
Merged
Conversation
f039142 to
3cdca62
Compare
jarednova
requested changes
Oct 9, 2020
Member
jarednova
left a comment
There was a problem hiding this comment.
Made a few tweaks. Then I remembered that I should do it as a review instead of just going and changing things. So one more tweak I found ("implements" vs. "implement"). Otherwise this is a super clear and helpful explanation and illustration of the problem/solution.
Co-authored-by: Jared Novack <jarednova@upstatement.com>
Member
Author
|
@jarednova Thanks for checking! I think it’s totally fine to fix typos and grammatical issues directly. But suggestions work great as well 👍. I’ll leave it to you to merge this in. |
Member
|
👍 |
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
2 participants
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.
Ticket: #2311
Issue
As one of the final documentation issues in #2073, we should document JSON serialization of posts that was added in #2311.
Solution
Take a stab at adding an example with a book post.
Impact
Even more insights about posts and advanced Timber coding.
Usage Changes
None.
Considerations
@acobster I hope I got everything right!
Also, in #2311 (comment) you had an idea to implement
jsonSerialize()inTimber\Post.I’m still not sure about that, but I think it might be hard to figure out which data is added by default, because this depends sooo much on the use case. Maybe not defining a default isn’t all that bad after all?
Testing
Nope.