Mention timeout unit in ENetConnection::service docs
#93927
Merged
Conversation
This file contains 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
AThousandShips
added
enhancement
documentation
cherrypick:4.1
akien-mga
approved these changes
Jul 4, 2024
akien-mga
changed the title
ENetConnection::service() docstimeout unit in ENetConnection::service docs
akien-mga
changed the title
timeout unit in ENetConnection::service docstimeout unit in ENetConnection::service docs
AThousandShips
removed
the
cherrypick:4.3
|
It is very unorthodox to mention the only parameter of this method in its own line at the very bottom of the description. |
akien-mga
reviewed
Jul 4, 2024
akien-mga
force-pushed
the
tweak-enetconnection-doc
branch
from
f6f174b
to
0a822af
Compare
mhilbrunner
approved these changes
Jul 4, 2024
There was a problem hiding this comment.
Note that this is an upstream ENet function, and the docs are verbatim ENet docs.
timeout is a bit tricky here: see discussion here and here.
With these possible footguns, we should maybe add some further advice and information here, or at least point to it elsewhere.
That said, that can be followup work or an issue, this PR is good and correct as far as I can see. Thanks for taking the time to improve something you had to find out yourself for everyone else :)
|
Thanks! And congrats for your first merged Godot contribution 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add a note about
timeoutfield being in milliseconds.Had to test locally to figure it out haha.