Skip to content

style: improve documentation for async ports #108

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

Merged
merged 1 commit into from
Jun 11, 2025
Merged

Conversation

hasezoey
Copy link
Contributor

ISSUE NUMBER - PULL_REQUEST_TITLE

fixes #107

Description

Document how the ports expect events to be returned and how the function should behave.

Type of change

Please select relevant options.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist

  • My code follows the contribution guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I formatted the code with cargo fmt
  • I checked my code using cargo clippy and reports no warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I have introduced no new C-bindings
  • The changes I've made are Windows, MacOS, UNIX, Linux compatible (or I've handled them using cfg target_os)
  • I increased or maintained the code coverage for the project, compared to the previous commit

@SteveXCIV do the changes address the documentation issue fully, or is there still some problem?

Copy link

@SteveXCIV SteveXCIV left a comment

Choose a reason for hiding this comment

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

@hasezoey LGTM - thanks!

@veeso
Copy link
Owner

veeso commented Jun 11, 2025

@hasezoey Thank you! Please fix conflicts

@hasezoey
Copy link
Contributor Author

Fixed

@veeso veeso merged commit fd9ced2 into veeso:main Jun 11, 2025
4 checks passed
@hasezoey hasezoey deleted the portDocs branch June 12, 2025 08:06
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.

[Feature Request] - Improve documentation for PollAsync::poll
3 participants