Document RenderRoot fields #824
Conversation
Remove duplicate CursorIcon field.
| /// The IME area last sent to the platform. | ||
| /// | ||
| /// This allows only sending the area to the platform when the area has changed. | ||
|
|
||
| /// The area in which text is being edited. |
There was a problem hiding this comment.
I think this is worse than what was there before? How does this improve clarity?
There was a problem hiding this comment.
Overall I'm trying to document "what does this field represent" more than "when is it updated".
There was a problem hiding this comment.
I'd claim that this new doc comment is actively worse than not having a comment at all. The name of the field is clearer for what it is for...
I do agree that we should have documented this workaround more clearly, but I'm not sure I agree that gutting the existing documentation is the right way to force that.
There was a problem hiding this comment.
I don't really like the new gaps between fields. I would rather that related fields (size_policy, size, scale_factor for example) were grouped without newlines.
| pub(crate) scroll_request_targets: Vec<(WidgetId, Rect)>, | ||
|
|
||
| /// List of ancestors of the currently hovered widget. |
There was a problem hiding this comment.
Maybe here would be a good reason to explain why we store this (i.e. so that hover state can be properly tracked after a reparenting)
Remove duplicate CursorIcon field.