Skip to content

Move and simplify Object's connect description slightly #94143

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

Conversation

Mickeon
Copy link
Contributor

@Mickeon Mickeon commented Jul 9, 2024

Fixes #94122 (although there should be a scroll-bar really, just in case)

This PR moves the extremely, utterly excessively long description of Object connect to Signal's leading description, and attempts to simplify it slightly. It also rewords things around connect for more consistency.

This part of the docs has always been a pain to figure out. I don't know why someone thought it was a good idea to have it here. Now we're left with a lot of verbose info that I am not sure has ever been necessary, nor fitting for a method description.

@Mickeon Mickeon added this to the 4.3 milestone Jul 9, 2024
@Mickeon Mickeon requested a review from a team as a code owner July 9, 2024 17:31
@Mickeon Mickeon force-pushed the documentation-object-connect-to-signal-too-long-didn't-read branch from 7ab1eeb to d45a602 Compare July 9, 2024 17:33
@Mickeon Mickeon modified the milestones: 4.3, 4.x Jul 9, 2024
@Mickeon Mickeon added cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release labels Jul 9, 2024
@Mickeon Mickeon force-pushed the documentation-object-connect-to-signal-too-long-didn't-read branch from d45a602 to 824d4ee Compare July 9, 2024 19:21
@akien-mga akien-mga removed the cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release label Mar 19, 2025
@Mickeon Mickeon requested a review from Calinou April 3, 2025 19:09
Copy link
Member

@Calinou Calinou left a comment

Choose a reason for hiding this comment

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

Looks good to me. I agree this is best documented in Signal since we want to encourage the use of first-class signals as much as possible.

@Mickeon Mickeon modified the milestones: 4.x, 4.5 Apr 9, 2025
@Mickeon Mickeon added cherrypick:4.4 Considered for cherry-picking into a future 4.4.x release and removed cherrypick:4.3 Considered for cherry-picking into a future 4.3.x release labels Apr 9, 2025
@Repiteo Repiteo merged commit cf3f02c into godotengine:master Apr 9, 2025
18 checks passed
@Repiteo
Copy link
Contributor

Repiteo commented Apr 9, 2025

Thanks!

@Mickeon Mickeon deleted the documentation-object-connect-to-signal-too-long-didn't-read branch April 10, 2025 07:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cherrypick:4.4 Considered for cherry-picking into a future 4.4.x release documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[C#] GodotObject.Connect() has too long description in Visual Studio tooltip
4 participants