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

[3.x] Rewrite most of Resource's documentation #86642

Merged

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Dec 30, 2023

Closes godotengine/godot-docs#6479 (Happy anniversary).

Kind of a 3.x version of #67072.

This PR brings the Resource's class reference in line with master's, with a few tweaks to suit 3.x:

  • PROPERTY_USAGE_ALWAYS_DUPLICATE cannot be mentioned because it does not exist.
  • The example resources and servers in get_rid() are different.

Now, what to do with setup_local_to_scene? Should it be deprecated here, too?

@Mickeon Mickeon requested a review from a team as a code owner December 30, 2023 17:01
@AThousandShips AThousandShips added this to the 3.x milestone Dec 30, 2023
@Mickeon Mickeon force-pushed the 3.x-doc-peeves-resourceful-uh-oh-stinky branch 2 times, most recently from 9157b29 to 1b91208 Compare December 30, 2023 17:13
@akien-mga
Copy link
Member

Now, what to do with setup_local_to_scene? Should it be deprecated here, too?

No, we shouldn't change the 3.x API at this stage. The branch is in maintenance mode and any API change won't be notice by users, and only risks affecting existing users of the feature.

@Mickeon Mickeon force-pushed the 3.x-doc-peeves-resourceful-uh-oh-stinky branch from 1b91208 to 2985890 Compare January 5, 2024 10:20
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 5, 2024

There you go. Removed the deprecation note

@Mickeon Mickeon force-pushed the 3.x-doc-peeves-resourceful-uh-oh-stinky branch from 2985890 to 1dee97a Compare January 5, 2024 10:36
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 5, 2024

Double-checked the examples. randi_range() also does not exist in 3.x, so it's been replaced.

@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 26, 2024

May someone take a glance at this again?

@akien-mga akien-mga modified the milestones: 3.x, 3.6 Jan 26, 2024
@akien-mga akien-mga merged commit 1aa4c2f into godotengine:3.x Jan 29, 2024
13 checks passed
@akien-mga
Copy link
Member

Thanks!

@Mickeon Mickeon deleted the 3.x-doc-peeves-resourceful-uh-oh-stinky branch January 29, 2024 22:40
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.

3 participants