-
-
Notifications
You must be signed in to change notification settings - Fork 21.9k
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
Clarify CanvasItem's visibility signal descriptions (followup) #97367
Clarify CanvasItem's visibility signal descriptions (followup) #97367
Conversation
a02a910
to
c0a55da
Compare
Personally, you usually need to look at each description such that they can be understood individually. Unless, say, there's a whole lot of explaining to do that does not warrant repetition. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually like the prior descriptions more, I feel out of the loop here. I do understand that top_level
's existence makes the statement misleading, though.
The |
Ah, dang. I made the changes quickly as I share @kleonc's view to keep the description correct and compact, but I can see how it makes it less easy to comprehend. How do you suggest I continue @Mickeon? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry for a bit of delayed answer (if that was a concern).
The description can be compact, sure, but it also needs to be as meaningful and "digestible" as it can be with a few words. The previous description was too compact and didn't say anything much of substance, either.
c0a55da
to
56ec624
Compare
It's tricky navigating the various different documentation styles of different collaborators, but I think my current wording is solid! Let me know what you think. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one more thing and I think this is excellent in my eyes.
Edit: Forgot to send.
f80f0b6
to
6865df3
Compare
6865df3
to
b336918
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added last small nitpick, otherwise it's fine to me. Thanks @AdriaandeJongh for the patience with us (me)! 🙂
b336918
to
9b474e3
Compare
Thanks! |
Follow-up to: #97223 (comment)
Simplifies the signal descriptions of
CanvasItem
'shidden
andvisibility_changed
. I tried a couple different ways of having the description forhidden
refer to thevisibility_changed
description, but ashidden
is just above it, it would read weird? idk.It's curious that thehidden
signal still exists even though thevisibility_changed
signal (albeit together with a simple check tois_visible_in_tree
in the connected callable) essentially supersedes it, but I don't know any C++ to deprecate the signal and start a transition to remove it. Perhaps someone else could pick that up.