Skip to content

Conversation

Udai-Senevirathne
Copy link
Contributor

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:

  • Fixed grammar errors in share_plus README ("warranty" → "warrant", improved UI error message)
  • Added missing imports to all code examples across multiple plugins
  • Made connectivity_plus code example complete and runnable with proper class structure
  • Added imports to sensors_plus and android_alarm_manager_plus examples

Impact:

  • Developers can now copy-paste working code directly from README files
  • Improved grammar makes documentation more professional
  • Better developer experience when learning to use these plugins

Files Changed:

  • packages/share_plus/share_plus/README.md
  • packages/connectivity_plus/connectivity_plus/README.md
  • packages/sensors_plus/sensors_plus/README.md
  • packages/android_alarm_manager_plus/README.md

Related Issues

No specific issues were referenced, but this addresses general documentation quality improvements that help all users of these plugins.

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I titled the PR using Conventional Commits.
  • I did not modify the CHANGELOG.md nor the plugin version in pubspec.yaml files.
  • All existing and new tests are passing.
  • The analyzer (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?

  • Yes, this is a breaking change (please indicate that with a ! in the title as explained in Conventional Commits).
  • No, this is not a breaking change.

- 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 Udai-Senevirathne changed the title Docs/improve documentation quality across multiple README files "docs: improve documentation quality across multiple README files" Jul 26, 2025
@Udai-Senevirathne Udai-Senevirathne changed the title "docs: improve documentation quality across multiple README files" docs: improve documentation quality across multiple README files Jul 26, 2025
- 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 vbuberen changed the title docs: improve documentation quality across multiple README files docs(all): improve documentation quality across multiple README files Aug 5, 2025
Copy link
Collaborator

@vbuberen vbuberen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution.

@vbuberen vbuberen merged commit 643e12d into fluttercommunity:main Aug 5, 2025
3 checks passed
@Udai-Senevirathne Udai-Senevirathne deleted the docs/improve-share-plus-readme branch August 5, 2025 07:16
@Udai-Senevirathne
Copy link
Contributor Author

Thanks for your contribution.

Thank you! I appreciate the warm welcome and the opportunity to contribute. I'm excited to continue learning and collaborating with the community.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants