docs(all): improve documentation quality across multiple README files#3630
Merged
vbuberen merged 5 commits intofluttercommunity:mainfrom Aug 5, 2025
Merged
Conversation
- Fix grammar errors: 'warranty' 'warrant', improve UI error message - Add missing imports to all code examples for better usability - Ensure all code examples are complete and runnable These changes make the documentation more accurate and help developers copy-paste working code examples directly from the README.
- connectivity_plus: make code example complete and runnable with proper class structure - sensors_plus: add missing import for magnetometer example - android_alarm_manager_plus: add missing import for alarm example All examples now include necessary imports and complete code structure for developers to copy-paste and use directly.
Udai-Senevirathne
changed the title
Udai-Senevirathne
changed the title
- android_intent_plus: add import for AndroidIntent usage example - share_plus: add missing imports to web fallback, XFile.fromData, and URI examples - include dart:convert import for utf8.encode usage All code examples now have complete import statements for copy-paste usage.
vbuberen
changed the title
vbuberen
approved these changes
Aug 5, 2025
Collaborator
vbuberen
left a comment
vbuberen
left a comment
There was a problem hiding this comment.
Thanks for your contribution.
Contributor
Author
Thank you! I appreciate the warm welcome and the opportunity to contribute. I'm excited to continue learning and collaborating with the community. |
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.
Description
This PR improves documentation quality across multiple plugin README files by fixing grammar errors, adding missing imports to code examples, and ensuring all examples are complete and runnable.
Changes Made:
Impact:
Files Changed:
packages/share_plus/share_plus/README.mdpackages/connectivity_plus/connectivity_plus/README.mdpackages/sensors_plus/sensors_plus/README.mdpackages/android_alarm_manager_plus/README.mdRelated Issues
No specific issues were referenced, but this addresses general documentation quality improvements that help all users of these plugins.
Checklist
CHANGELOG.mdnor the plugin version inpubspec.yamlfiles.flutter analyze) does not report any problems on my PR.Breaking Change
Does your PR require plugin users to manually update their apps to accommodate your change?
!in the title as explained in Conventional Commits).