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

Update troubleshooting steps #57

Merged
merged 5 commits into from
Nov 1, 2024
Merged

Conversation

AdminCrystal
Copy link
Contributor

I personally got affected by this, contributing back to help others.

I personally got affected by this, contributing back to help others.
Copy link
Member

@Bromeon Bromeon left a comment

Choose a reason for hiding this comment

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

Thanks a lot! 🙂

I think the idea is good, however the way it is written conveys several misconceptions:

  • The versions don't need to match. Godot >= gdext is required though.
  • We don't keep the default up to date with the latest release, but with latest minor release.
  • Recommending a specific API version like api-4-2-2 is usually not a good idea, unless one needs APIs from 4.2.2 that aren't available in 4.2 already. But sticking to minor versions (api-4-2) increases the compatibility range without losing much.

This is all already explained in https://godot-rust.github.io/book/toolchain/godot-version.html, so I would not reiterate it at that point, but rather write something like:

Are your gdext and Godot versions compatible? See this page for how to select the correct versions.

@AdminCrystal
Copy link
Contributor Author

Thanks a lot! 🙂

I think the idea is good, however the way it is written conveys several misconceptions:

  • The versions don't need to match. Godot >= gdext is required though.
  • We don't keep the default up to date with the latest release, but with latest minor release.
  • Recommending a specific API version like api-4-2-2 is usually not a good idea, unless one needs APIs from 4.2.2 that aren't available in 4.2 already. But sticking to minor versions (api-4-2) increases the compatibility range without losing much.

This is all already explained in https://godot-rust.github.io/book/toolchain/godot-version.html, so I would not reiterate it at that point, but rather write something like:

Are your gdext and Godot versions compatible? See this page for how to select the correct versions.

Thank you for explaining it that makes a lot of sense, have updated the pr to fit your comments and I agree linking to existing documentation is better than reiterating.

@Bromeon
Copy link
Member

Bromeon commented Nov 1, 2024

Thanks! Renamed the label since api-... indicates a link to the API docs.

@Bromeon Bromeon merged commit 87de368 into godot-rust:master Nov 1, 2024
4 checks passed
@Bromeon Bromeon added the enhancement Ongoing improvements to readability, flow, etc. label Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Ongoing improvements to readability, flow, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants