🔧 Updated documentation for collect function regarding isolate groups (#533)

[Victowolf]

• Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below.

---

• I’ve reviewed the contributor guide and applied the relevant portions to this PR.

Contribution guidelines:

• See our contributor guide for general expectations for PRs.
• Larger or significant changes should be discussed in an issue before creating a PR.
• Contributions to our repos should follow the Dart style guide and use dart format.
• Most changes should add an entry to the changelog and may need to rev the pubspec package version.
• Changes to packages require corresponding tests.

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

🔧 Updated documentation for collect function regarding isolate groups (#533)

Pull Request Description

This PR updates the documentation for the collect function to provide better clarity on how it handles isolate groups. The changes aim to:

✅ Improve readability and maintainability of the documentation.
✅ Clearly explain the behavior of collect in scenarios involving isolate groups.
✅ Address issue #533 by enhancing the function’s inline comments and docstrings.

Changes Made:

📌 Updated lib/src/collect.dart with improved documentation.

Checklist:

• Documentation updated
• Code follows project guidelines
• Ready for review

[liamappelbe]

The PR includes a bunch of unrelated changes. Looks like it got mixed up with #2029

Also, needs to be synced to head