Skip to content
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

Improve documentation grammar and wording #5052

Merged
merged 4 commits into from
Sep 22, 2024
Merged

Conversation

Swarkin
Copy link
Contributor

@Swarkin Swarkin commented Sep 1, 2024

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

@Swarkin
Copy link
Contributor Author

Swarkin commented Sep 2, 2024

Fixed conflicts

@Swarkin
Copy link
Contributor Author

Swarkin commented Sep 12, 2024

Fixed conflicts

@emilk emilk added docs and examples Improving and adding documentation and examples egui exclude from changelog labels Sep 16, 2024
@emilk emilk changed the title Update documentation grammar and wording Improve documentation grammar and wording Sep 16, 2024
@emilk
Copy link
Owner

emilk commented Sep 16, 2024

needs cargo fmt

@Swarkin
Copy link
Contributor Author

Swarkin commented Sep 22, 2024

Hi, cargo fmt does not change anything for me.

@lucasmerlin
Copy link
Collaborator

@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
Copy link
Contributor Author

Swarkin commented Sep 22, 2024

Done

Copy link

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.

@emilk emilk merged commit 07ccf41 into emilk:master Sep 22, 2024
22 checks passed
@Swarkin Swarkin deleted the patch-1 branch September 22, 2024 19:08
hacknus pushed a commit to hacknus/egui that referenced this pull request Oct 30, 2024
This PR aims to make the documentation comments easier to read and
understand.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs and examples Improving and adding documentation and examples egui exclude from changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants