diff --git a/eframe/README.md b/eframe/README.md index 1d66675a..a6e4ef9f 100644 --- a/eframe/README.md +++ b/eframe/README.md @@ -25,7 +25,7 @@ To use on Linux, first run: sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libspeechd-dev libxkbcommon-dev libssl-dev ``` -You need to either use `edition = "2021"`, or set `resolver = "2"` in the `[workspace`] section of your to-level `Cargo.toml`. See [this link](https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html) for more info. +You need to either use `edition = "2021"`, or set `resolver = "2"` in the `[workspace]` section of your to-level `Cargo.toml`. See [this link](https://doc.rust-lang.org/edition-guide/rust-2021/default-cargo-resolver.html) for more info. You can opt-in to the using [`egui_wgpu`](https://github.com/emilk/egui/tree/master/egui_wgpu) for rendering by enabling the `wgpu` feature and setting `NativeOptions::renderer` to `Renderer::Wgpu`. diff --git a/eframe/src/epi.rs b/eframe/src/epi.rs index 7d735c06..d04e5089 100644 --- a/eframe/src/epi.rs +++ b/eframe/src/epi.rs @@ -475,7 +475,7 @@ pub struct Location { /// /// Note that the leading `?` is NOT included in the string. /// - /// Use [`Self::web_query_map]` to get the parsed version of it. + /// Use [`Self::query_map`] to get the parsed version of it. pub query: String, /// The parsed "query" part of "www.example.com/index.html?query#fragment". diff --git a/egui/src/style.rs b/egui/src/style.rs index 7bc83a0d..736d2981 100644 --- a/egui/src/style.rs +++ b/egui/src/style.rs @@ -21,14 +21,14 @@ pub enum TextStyle { /// Normal labels. Easily readable, doesn't take up too much space. Body, - /// Same size as [`Self::Body]`, but used when monospace is important (for aligning number, code snippets, etc). + /// Same size as [`Self::Body`], but used when monospace is important (for aligning number, code snippets, etc). Monospace, - /// Buttons. Maybe slightly bigger than [`Self::Body]`. + /// Buttons. Maybe slightly bigger than [`Self::Body`]. /// Signifies that he item is interactive. Button, - /// Heading. Probably larger than [`Self::Body]`. + /// Heading. Probably larger than [`Self::Body`]. Heading, /// A user-chosen style, found in [`Style::text_styles`]. diff --git a/egui/src/ui.rs b/egui/src/ui.rs index 51215e08..9e613ea6 100644 --- a/egui/src/ui.rs +++ b/egui/src/ui.rs @@ -1952,7 +1952,7 @@ impl Ui { /// ``` /// /// See also [`Self::allocate_ui_with_layout`], - /// and the helpers [`Self::horizontal]`, [`Self::vertical`], etc. + /// and the helpers [`Self::horizontal`], [`Self::vertical`], etc. #[inline] pub fn with_layout( &mut self, diff --git a/egui_extras/src/layout.rs b/egui_extras/src/layout.rs index 35988b95..9a83e22e 100644 --- a/egui_extras/src/layout.rs +++ b/egui_extras/src/layout.rs @@ -12,10 +12,10 @@ pub(crate) enum CellSize { /// /// In a strip there's only one line which goes in the direction of the strip: /// -/// In a horizontal strip, a `[StripLayout]` with horizontal `[CellDirection]` is used. -/// Its cells go from left to right inside this `[StripLayout]`. +/// In a horizontal strip, a [`StripLayout`] with horizontal [`CellDirection`] is used. +/// Its cells go from left to right inside this [`StripLayout`]. /// -/// In a table there's a `[StripLayout]` for each table row with a horizontal `[CellDirection]`. +/// In a table there's a [`StripLayout`] for each table row with a horizontal [`CellDirection`]. /// Its cells go from left to right. And the lines go from top to bottom. pub(crate) enum CellDirection { /// Cells go from left to right. @@ -24,7 +24,7 @@ pub(crate) enum CellDirection { Vertical, } -/// Positions cells in `[CellDirection]` and starts a new line on `[StripLayout::end_line]` +/// Positions cells in [`CellDirection`] and starts a new line on [`StripLayout::end_line`] pub struct StripLayout<'l> { pub(crate) ui: &'l mut Ui, direction: CellDirection, diff --git a/egui_extras/src/strip.rs b/egui_extras/src/strip.rs index dcfb97c9..ac33ed18 100644 --- a/egui_extras/src/strip.rs +++ b/egui_extras/src/strip.rs @@ -12,7 +12,7 @@ use egui::{Response, Ui}; /// In contrast to normal egui behavior, strip cells do *not* grow with its children! /// /// First use [`Self::size`] and [`Self::sizes`] to allocate space for the rows or columns will follow. -/// Then build the strip with `[Self::horizontal]`/`[Self::vertical]`, and add 'cells' +/// Then build the strip with [`Self::horizontal`]/[`Self::vertical`], and add 'cells' /// to it using [`Strip::cell`]. The number of cells MUST match the number of pre-allocated sizes. /// /// ### Example @@ -89,7 +89,7 @@ impl<'a> StripBuilder<'a> { /// Build horizontal strip: Cells are positions from left to right. /// Takes the available horizontal width, so there can't be anything right of the strip or the container will grow slowly! /// - /// Returns a `[egui::Response]` for hover events. + /// Returns a [`egui::Response`] for hover events. pub fn horizontal(self, strip: F) -> Response where F: for<'b> FnOnce(Strip<'a, 'b>), @@ -116,7 +116,7 @@ impl<'a> StripBuilder<'a> { /// Build vertical strip: Cells are positions from top to bottom. /// Takes the full available vertical height, so there can't be anything below of the strip or the container will grow slowly! /// - /// Returns a `[egui::Response]` for hover events. + /// Returns a [`egui::Response`] for hover events. pub fn vertical(self, strip: F) -> Response where F: for<'b> FnOnce(Strip<'a, 'b>), diff --git a/egui_extras/src/table.rs b/egui_extras/src/table.rs index 28d788d1..7fc3022c 100644 --- a/egui_extras/src/table.rs +++ b/egui_extras/src/table.rs @@ -394,7 +394,7 @@ impl<'a> TableBody<'a> { /// Add a single row with the given height. /// - /// If you have many thousands of row it can be more performant to instead use [`Self::rows]` or [`Self::heterogeneous_rows`]. + /// If you have many thousands of row it can be more performant to instead use [`Self::rows`] or [`Self::heterogeneous_rows`]. pub fn row(&mut self, height: f32, row: impl FnOnce(TableRow<'a, '_>)) { row(TableRow { layout: &mut self.layout,