Add much more detailed comments throughout the new atom-based radio_button widget #7496
Conversation
Resonanz
changed the title
Added button and checkbox documentation (previously added radio_button documentation).
| use crate::{ | ||
| Atom, AtomExt as _, AtomKind, AtomLayout, AtomLayoutResponse, Color32, CornerRadius, Frame, | ||
| Image, IntoAtoms, NumExt as _, Response, Sense, Stroke, TextStyle, TextWrapMode, Ui, Vec2, | ||
| Widget, WidgetInfo, WidgetText, WidgetType, |
There was a problem hiding this comment.
are these comments really needed??
this so much more lines which I don't really think we need
There was a problem hiding this comment.
I think having a heavily documented widget is helpful for those that are new to rust, or who are finding their way to how widgets work, or who require a more in-depth explanation.
There was a problem hiding this comment.
I agree that comments inside functions and doc-comments over it are helpful (I didn't read those ones), but commenting of imports is superfluous. That documentation should be on the imported things itself.
| @@ -1,137 +1,311 @@ | |||
| // Import necessary types and traits from the crate | |||
| use crate::{ | |||
| Atom, AtomLayout, Atoms, Id, IntoAtoms, NumExt as _, Response, Sense, Shape, Ui, Vec2, Widget, | |||
| // Import necessary types and traits from the crate | ||
| use crate::{ | ||
| Atom, AtomLayout, Atoms, Id, IntoAtoms, NumExt as _, Response, Sense, Ui, Vec2, Widget, | ||
| WidgetInfo, WidgetType, epaint, |
| // Get visual styling based on the widget's interaction state | ||
| // Note: We use the general interact() method instead of interact_selectable() | ||
| // because the selectable version can be "too colorful" according to the comment |
There was a problem hiding this comment.
Lol, according to what comment?
| // Small buttons get no vertical padding | ||
| if small { | ||
| button_padding.y = 0.0; | ||
| } |
There was a problem hiding this comment.
I feel like the majority of code comments don't add much value. Do you really need a comment to know that this disables vertical padding for small buttons?
In general, code should be written in a way that makes it obvious what is going on, and comments should explain things that aren't obvious from the code, for example why something is done.
|
If you think these comments are useful, then you can generate them locally (like you did). No need to commit them. |
|
this just feels like copilot was told to comment the project xD |
5 participants
The goal of this pull request is to add many more detailed comments to the
radio_buttonwidget code to help better understand the new atom-based widgets.A visual diff has been completed and the demo app has been compiled to check for errors or warning:
cargo run --release -p egui_demo_appThe comments were written by Claude AI and have been entirely checked to the best of my ability.