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 documentation in MultiplayerAPIExtension #84226

Merged
merged 1 commit into from
Nov 1, 2023

Conversation

Agaanii
Copy link
Contributor

@Agaanii Agaanii commented Oct 31, 2023

In implementing a MultiplayerAPIExtension, I found that the example from documentation did not function even in the Multiplayer tutorial example.

Eventually, I found that the issue was that base_multiplayer will not poll unless told to by the LogMultiplayer implementation. With my changes, the example code compiles and functions in that project in 4.1.

I also corrected a spelling issue and a few out-of-date return types.

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, see the style nitpick (which should let this pass CI).
Thanks for looking into this 👍 🏆

doc/classes/MultiplayerAPIExtension.xml Outdated Show resolved Hide resolved
@akien-mga
Copy link
Member

Looks good! Could you squash the commits? See PR workflow for instructions.

@Agaanii
Copy link
Contributor Author

Agaanii commented Oct 31, 2023

Commits squashes, thanks for the link.

@akien-mga
Copy link
Member

Last adjustment, could you amend the commit message so that the title is "Fix documentation in MultiplayerAPIExtension" instead of the current "Update doc/classes/MultiplayerAPIExtension.xml"? And you can probably drop the line making @Faless a co-author, he just provided some style fix suggestions.

@AThousandShips AThousandShips changed the title Fix documentation in MultiplayerAPIExtension.xml Fix documentation in MultiplayerAPIExtension Oct 31, 2023
Fix documentation in MultiplayerAPIExtension.xml

In implementing a MultiplayerAPIExtension, I found that the example from documentation did not function even in the Multiplayer tutorial example.

Eventually, I found that the issue was that base_multiplayer will not poll unless told to by the LogMultiplayer implementation.

I also corrected a spelling issue and a few out-of-date return types.
@Agaanii
Copy link
Contributor Author

Agaanii commented Nov 1, 2023

Updated

Thanks for the help on doing a PR, I haven't done it for public repos before.

@akien-mga akien-mga merged commit 8ce3198 into godotengine:master Nov 1, 2023
15 checks passed
@akien-mga
Copy link
Member

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants