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.

Sign up for GitHub

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

Jump to bottom

Add missing descriptions to remaining signals #87047

Merged
merged 1 commit into from
Jan 24, 2024
Merged

Add missing descriptions to remaining signals #87047

merged 1 commit into from
Jan 24, 2024

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Jan 10, 2024

This PR adds descriptions to signals which were previously missing one.
These are:

  • GraphEdit's node_deselected signal.
  • Skeleton3D's bone_enabled_changed, pose_updated and show_rest_only_changed signals.
    • And by extension, the show_rest_only property and the NOTIFICATION_UPDATE_SKELETON constant.

It also tweaks the descriptions of surrounding signals very slightly.

This also would make all signals in the class reference documented. 100%.

@Mickeon Mickeon requested a review from a team as a code owner January 10, 2024 17:07
@Mickeon Mickeon mentioned this pull request Jan 10, 2024
Merged
@AThousandShips AThousandShips added this to the 4.3 milestone Jan 10, 2024
@Mickeon Mickeon force-pushed the documentation-missing-signals branch from 2c4deca to ca506aa Compare January 10, 2024 17:55
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 10, 2024

I gave my best shot at updating the descriptions of those few surrounding methods too, to give them slightly more detail. But, I have little knowledge on them at the moment, and they may be factually incorrect.

@YuriSizov YuriSizov self-requested a review January 19, 2024 10:12
@Mickeon Mickeon force-pushed the documentation-missing-signals branch from ca506aa to 409db37 Compare January 19, 2024 10:49
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 19, 2024

Updated the PR to replace those "such as" with "for example".

YuriSizov
YuriSizov suggested changes Jan 22, 2024
View reviewed changes
Copy link
Contributor

@YuriSizov YuriSizov left a comment

Choose a reason for hiding this comment

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

Sorry for not reviewing sooner and thanks for looking into the remaining descriptions. I recommend doing some adjustments, but otherwise it's good.

@Mickeon Mickeon force-pushed the documentation-missing-signals branch from 409db37 to 98582d7 Compare January 22, 2024 22:42
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 22, 2024

Updated the PR accounting for the above feedback

@Mickeon Mickeon requested a review from YuriSizov January 22, 2024 22:42
@YuriSizov YuriSizov added the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Jan 23, 2024
@YuriSizov
Copy link
Contributor

Amazing! One last thing, you've updated end_node_move to reference GraphElement, but you forgot to update begin_node_move. Once this is done, we can merge 👍

@Mickeon Mickeon force-pushed the documentation-missing-signals branch from 98582d7 to 8f10d7d Compare January 23, 2024 14:04
@Mickeon
Copy link
Contributor Author

Mickeon commented Jan 23, 2024

Should be all good soon

@YuriSizov YuriSizov changed the title Add missing descriptions to remaining signals. Add missing descriptions to remaining signals Jan 24, 2024
@YuriSizov YuriSizov merged commit 7f2d493 into godotengine:master Jan 24, 2024
16 checks passed
@YuriSizov
Copy link
Contributor

Thanks!

@Mickeon Mickeon deleted the documentation-missing-signals branch January 24, 2024 16:34
@YuriSizov YuriSizov removed the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Jan 25, 2024
@YuriSizov
Copy link
Contributor

Cherry-picked for 4.2.2.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AThousandShips AThousandShips AThousandShips approved these changes

@YuriSizov YuriSizov YuriSizov approved these changes

Assignees
No one assigned
Labels
documentation enhancement
Projects
None yet
Milestone
4.3
Development

Successfully merging this pull request may close these issues.
3 participants
@Mickeon @YuriSizov @AThousandShips