-
Notifications
You must be signed in to change notification settings - Fork 623
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs(serializers): Fix grammatical errors #2779
docs(serializers): Fix grammatical errors #2779
Conversation
"Let's study the alternatives" is slightly more formal and emphasizes the specific alternatives.
Replaces "Serializer has three required pieces" with "A serializer has three required pieces" for better specificity, consistency, and readability.
Clarify explanation of encodeToXxx and decodeFromXxx overloads
- Add missing articles to the section header - Change "Specifying serializer globally using typealias" to "Specifying a serializer globally using a typealias" - Improve readability and grammatical correctness
- Change "In the below example" to "In the example below" - Enhance readability and professionalism of text - Align with common technical writing conventions
Hi, thanks for all your corrections. I see that you've opened a lot of pull requests with small changes. May I ask you to combine all of them into one PR? It would be easier to review and merge it that way. |
@sandwwraith, Thanks for the input. I'll merge the pull requests as suggested. Just to clarify, the reason for the initial split into several small PRs was to make sure each update could be reviewed on its own, to simplify the management and discussion of each focused change, to reduce the chance of merge conflicts with other ongoing updates, and to make it easier to reject any non-essential changes by keeping them separate. I'm on it—starting the merge into one big PR now. If you need more details or have a preferred structure for the combined PR, just let me know. I will go ahead and close the previous PRs. |
…' into serializers-changes
…tion' into serializers-changes
…ng' into serializers-changes
@sandwwraith, should I commit the API dump files created using |
@jamhour1g API dump uses only signatures of the functions, so there is no need in that. |
- Change "Specifying serializer on a property" to "Specifying a serializer on a property" - Change "Specifying serializer for a particular type" to "Specifying a serializer for a particular type" These changes enhance readability and grammatical correctness in the documentation.
…dwritten' Correct the spelling of 'Hand-written' to 'Handwritten,' as it is commonly spelled as one word.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for all your efforts!
No description provided.