-
-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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
Update GDExtension docs with 4.1 branch info #7653
Update GDExtension docs with 4.1 branch info #7653
Conversation
Thanks! |
I don't understand how this bug process works. It's been over a week, the original bug has been closed, this ticket merged, and the page still is incorrect. Additionally, this bullet point is also incorrect:
With the changes to GDExtension, this needs to be the Godot 4.1. Godot 4.0 is not binary compatible with GDExtensions compiled under 4.0. One of the problems with writing:
is that it glosses over the other difference between Godot 4.0 and 4.1 (which is mentioned in #7648) - the change to the code in the class initializer It would be better to state at the top of the article something along the lines of:
The text can then proceed with the assumption that the user is using Godot 4.1 (or later). |
I'm not on the docs team, but my understanding is that PRs get merged into the "latest" docs first, which you can see here: https://docs.godotengine.org/en/latest/tutorials/scripting/gdextension/gdextension_cpp_example.html And then later (in batches) PRs that are labeled with "cherrypick:4.1" (like this one is!) will be cherrypicked into the 4.1 branch, which will be pushed into the "stable" docs at that point.
Thanks for the suggestions! I suspect the docs are written the way they are to try and be sort of "future proof", so that they hopefully won't need to be updated when 4.2 comes out (assuming we succeed in maintaining compatibility for 4.2 and beyond). Do you have any experience using Git and GitHub? If so, feel free to make a PR with your suggested changes! Otherwise, when I find some time, I'll make a PR that attempts to bridge the gap between 4.0 -> 4.1 update information, and "future proof" docs for 4.1+ |
@dcuny I just posted PR #7699 in attempt to address your concerns! Please let me know what think. I didn't follow your suggestions exactly, as I wanted to still attempt to make the page as "future proof" as possible, and not clutter it up with all the specifics related to the GDExtension breakage between Godot 4.0 and 4.1. |
The most important thing is that the instructions provided work with the version that it says it work with. 😄 I'm not sure how future-proof you can make it. You can be optimistic and hope that Thanks! |
Update GDExtension docs with 4.1 branch info
Fixes #7648