search

emilk / egui

egui: an easy-to-use immediate mode GUI in Rust that runs on both web and native
https://www.egui.rs/
Apache License 2.0
21.88k stars 1.58k forks source link

Improve documentation grammar and wording #5052

Closed Swarkin closed 1 week ago

Swarkin commented 4 weeks ago

This PR aims to make the documentation comments easier to read and understand.

Swarkin commented 3 weeks ago

Fixed conflicts

Swarkin commented 2 weeks ago

Fixed conflicts

emilk commented 2 weeks ago

needs cargo fmt

Swarkin commented 1 week ago

Hi, cargo fmt does not change anything for me.

lucasmerlin commented 1 week ago

@Swarkin hmm, maybe you are on an older rust version? Checking the output of the Rust / Format + check + test check will also tell you whats wrong: 

Diff in /home/runner/work/egui/egui/crates/egui/src/memory/mod.rs at line 172:
     #[cfg_attr(feature = "serde", serde(skip))]
     pub dark_style: std::sync::Arc<Style>,

-
     /// The default style for new [`Ui`](crate::Ui):s in light mode.
     #[cfg_attr(feature = "serde", serde(skip))]
     pub light_style: std::sync::Arc<Style>,
Diff in /home/runner/work/egui/egui/crates/egui/src/memory/mod.rs at line [18](https://github.com/emilk/egui/actions/runs/10832498741/job/30187822132?pr=5052#step:6:19)8:
     ///
     /// Default: [`crate::Theme::Dark`].
     pub fallback_theme: Theme,
-

     /// The current system theme, used to choose between
     /// dark and light style in case [`Self::theme_preference`] is [`ThemePreference::System`].

(you will need to remove the lines marked with -)

Swarkin commented 1 week ago

Done

github-actions[bot] commented 1 week ago

Preview available at https://egui-pr-preview.github.io/pr/5052-patch-1 Note that it might take a couple seconds for the update to show up after the preview_build workflow has completed.