godot icon indicating copy to clipboard operation
godot copied to clipboard

Improve docs for rpc annotations

Open GeroVeni opened this issue 2 years ago • 1 comments

  • Improve docs for the @rpc annotation
  • Add links in the docs from the Callable.rpc to Node.rpc which contains more detailed information about how rpc works
  • Mention the @rpc annotation in Node.rpc and Node.rpc_config docs
  • Correct @rpc(any) to @rpc(any_peer) in Node.rpc_config docs

GeroVeni avatar Jan 22 '23 15:01 GeroVeni

Now that you've changed the source of those annotations, default values in the docs should be kept as you were suggesting. This is why the CI build fails now. Make sure to run doctool locally.

You also need to rebase this PR, seems like there are now conflicts with recently merged changes.

YuriSizov avatar Jan 26 '23 16:01 YuriSizov

Please squash the commits into one. :)

mhilbrunner avatar Feb 01 '23 14:02 mhilbrunner

@mhilbrunner I messed up a bit with git and rebasing took a little while, but I think I managed to squash it all in one

GeroVeni avatar Feb 02 '23 14:02 GeroVeni

@YuriSizov I think it is good to go now

GeroVeni avatar Feb 04 '23 01:02 GeroVeni

@GeroVeni Yes, sorry, it should be good, but our spellcheck noticed you have a typo. If you could fix that, we should be okay to merge :)

YuriSizov avatar Feb 04 '23 13:02 YuriSizov

Thanks, and congrats on the first merged pull request!

YuriSizov avatar Feb 04 '23 15:02 YuriSizov

This PR does not take into account changes from #71634. I've added fixes to this in #72276.

dalexeev avatar Feb 05 '23 18:02 dalexeev

I think we missed an opportunity to explain what each of the arguments actually do. I have no idea and cannot find any breakdown anywhere in the code, documentation or editor. The closest I have are community youtube videos but they are out of date.

krazyjakee avatar Feb 10 '23 18:02 krazyjakee

I think we missed an opportunity to explain what each of the arguments actually do. I have no idea and cannot find any breakdown anywhere in the code, documentation or editor.

I think the best place for this information to go would be in the docs site when the tutorials are updated for Godot 4 (e.g. https://docs.godotengine.org/en/stable/tutorials/networking/high_level_multiplayer.html#rpc) and then provide a link in the code documentation to this tutorial page.

GeroVeni avatar Feb 13 '23 02:02 GeroVeni

Screenshot_20230509-072126.png

A guide I made.

krazyjakee avatar May 09 '23 06:05 krazyjakee