Skip to content
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

docs: clarify Member.current_timeout expiry #1063

Merged
merged 1 commit into from
Jun 22, 2023

Conversation

shiftinv
Copy link
Member

Summary

Tiny documentation change to clarify that Member.current_timeout also returns None when the current timeout value is in the past, allowing users to safely rely on this behavior.

Checklist

  • If code changes were made, then they have been tested
    • I have updated the documentation to reflect the changes
    • I have formatted the code properly by running pdm lint
    • I have type-checked the code by running pdm pyright
  • This PR fixes an issue
  • This PR adds something new (e.g. new method or parameters)
  • This PR is a breaking change (e.g. methods or parameters removed/renamed)
  • This PR is not a code change (e.g. documentation, README, ...)

@shiftinv shiftinv added t: documentation Improvements or additions to documentation/examples skip news labels Jun 22, 2023
@shiftinv shiftinv merged commit b73a359 into master Jun 22, 2023
@shiftinv shiftinv deleted the docs/current-timeout-expired branch June 22, 2023 22:00
shiftinv added a commit that referenced this pull request Oct 30, 2023
Tiny documentation change to clarify that `Member.current_timeout` also
returns `None` when the current timeout value is in the past, allowing
users to safely rely on this behavior.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip news t: documentation Improvements or additions to documentation/examples
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants