Document and clean up WidgetState #707
Conversation
masonry/ARCHITECTURE.md
Outdated
|
|
||
| Contains the WidgetState type, around which a lot of pass code is based. | ||
|
|
||
| The WidgetState documentation has helpful information on its fields and their naming scheme. |
There was a problem hiding this comment.
I don't think this line is helpful. To me, this reads like a comment that the rest of the codebase doesn't have helpful documentation, and so WidgetState is special in that it does?
There was a problem hiding this comment.
Maybe the doc could be reworded.
What I'm trying to say is "WidgetState is more important than other types. A lot of pass code uses its fields. You should look at its documentation and the pass code will probably be easier to understand."
masonry/src/contexts.rs
Outdated
| @@ -34,6 +34,9 @@ macro_rules! impl_context_method { | |||
| }; | |||
| } | |||
|
|
|||
| // Note - Look at the documentation for WidgetState information on its fields | |||
There was a problem hiding this comment.
| // Note - Look at the documentation for WidgetState information on its fields | |
| // Note - Look at the documentation for `WidgetState` for information on its fields |
Although similarly, I'm not sure who this comment helps.
masonry/src/widget/widget_state.rs
Outdated
|
|
||
| #[test] | ||
| #[ignore] | ||
| fn test_widget_size() { | ||
| // See https://github.com/linebender/xilem/issues/706 | ||
| let state = WidgetState::new(WidgetId::next(), "test"); | ||
| dbg!(std::mem::size_of_val(&state)); | ||
| panic!(); | ||
| } |
There was a problem hiding this comment.
| #[test] | |
| #[ignore] | |
| fn test_widget_size() { | |
| // See https://github.com/linebender/xilem/issues/706 | |
| let state = WidgetState::new(WidgetId::next(), "test"); | |
| dbg!(std::mem::size_of_val(&state)); | |
| panic!(); | |
| } |
The comment // See https://github.com/linebender/xilem/issues/706 isn't unhelpful, but should just go above the struct definition.
For most users, this information is readily available in the IDE.
A potentially useful test would be that the size isn't larger than say 256 bytes, but that's not what this is.
There was a problem hiding this comment.
For most users, this information is readily available in the IDE.
Oh, I didn't think of that.
There was a problem hiding this comment.
For most users, this information is readily available in the IDE.
Yeah it's super useful in rust-analyzer I use that a lot, and another pretty cool thing that recently landed in rust-analyzer (I'm not sure if it's stable though yet), is trait-object-safety (and the reason why it's not) that is shown when "hovering" above a trait.
Remove redundant test.
No description provided.