docs: improve grammar, clarity, and code examples and API docs#548
Merged
stevenh merged 3 commits intorobertkrimen:masterfrom Jun 13, 2025
Merged
docs: improve grammar, clarity, and code examples and API docs#548stevenh merged 3 commits intorobertkrimen:masterfrom
stevenh merged 3 commits intorobertkrimen:masterfrom
Conversation
- fixed grammar and punctuation issues - improved clarity and consistency in phrases - corrected minor code example errors
stevenh
requested changes
Jun 9, 2025
Collaborator
stevenh
left a comment
stevenh
left a comment
There was a problem hiding this comment.
Thanks for the PR, no need for commas after e.g. when using real english 😃
- Remove commas after 'e.g.' per maintainer feedback - Improve error handling in example code - Maintain consistency in documentation style Addresses feedback from PR robertkrimen#548
Contributor
Author
|
Thanks for the feedback! Ive removed the commas after "e.g." as suggested. I also enhanced the error handling in the first code example for better clarity. Let me know if there's anything else you'd like me to adjust. |
stevenh
requested changes
Jun 10, 2025
Collaborator
stevenh
left a comment
stevenh
left a comment
There was a problem hiding this comment.
Just a missing full stop and then good to go, thanks for the quick turn around.
Adds missing period at the end of the sentence in the Export function's documentation to maintain consistent punctuation style.
Contributor
Author
|
I've added the missing period to the Export function's documentation. The Pr should now be ready for your review. |
stevenh
approved these changes
Jun 13, 2025
Collaborator
|
Thanks for the PR @dev-kas |
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.
This PR updates the README and related docs to fix grammar issues, clarify language, and correct minor code example errors. The changes improves readability and consistency without changing any functionality.
Improvements:
fmt.Printfformat strings)These updates make the docs more professional and accessible for both new and experienced.