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

Fix packet details of ENetConnection EventType EVENT_RECEIVE documentation #80182

Conversation

mikemar10
Copy link
Contributor

@mikemar10 mikemar10 commented Aug 2, 2023

…ntation

The documentation for ENetConnection#service explains correctly that packets are queued in the associated ENetPacketPeer, however the documentation for EventType<enum ENetConnection_EventType>#EVENT_RECEIVE incorrectly states that the received packet is placed in the array returned from ENetConnection#service. This PR updates the documentation for EVENT_RECEIVE to correctly state that the packet is queued in the associated peer.

@mikemar10 mikemar10 requested a review from a team as a code owner August 2, 2023 17:30
@AThousandShips AThousandShips added this to the 4.x milestone Aug 2, 2023
@akien-mga akien-mga changed the title Fixes packet details of ENetConnection EventType EVENT_RECEIVE docume… Fixes packet details of ENetConnection EventType EVENT_RECEIVE documentation Aug 2, 2023
@akien-mga akien-mga changed the title Fixes packet details of ENetConnection EventType EVENT_RECEIVE documentation Fix packet details of ENetConnection EventType EVENT_RECEIVE documentation Aug 2, 2023
Copy link
Collaborator

@Faless Faless left a comment

Choose a reason for hiding this comment

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

LGTM 👍
Thanks!

@akien-mga akien-mga modified the milestones: 4.x, 4.2 Oct 12, 2023
@akien-mga akien-mga merged commit 85e508b into godotengine:master Oct 13, 2023
14 checks passed
@akien-mga
Copy link
Member

Thanks! And congrats for your first merged Godot contribution 🎉

@akien-mga akien-mga changed the title Fix packet details of ENetConnection EventType EVENT_RECEIVE documentation Fix packet details of ENetConnection EventType EVENT_RECEIVE documentation Oct 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect description of how packets are queued in ENetConnection EventType EVENT_RECEIVE
4 participants