diff options
author | Ivan Tham | 2021-06-19 15:11:26 +0000 |
---|---|---|
committer | Ivan Tham | 2021-06-20 15:13:36 +0000 |
commit | 985625763addd839a101263ae90cfb2f205830fc (patch) | |
tree | f6b682218211b2c29e4ab88f65dcb86b88cc2f46 | |
parent | eaf259f8aa57c170e0f3268c837bbb25b934bf80 (diff) |
Fix doc warnings
-rw-r--r-- | helix-term/src/compositor.rs | 14 | ||||
-rw-r--r-- | helix-tui/src/lib.rs | 2 | ||||
-rw-r--r-- | helix-tui/src/widgets/mod.rs | 2 | ||||
-rw-r--r-- | helix-view/src/document.rs | 2 |
4 files changed, 10 insertions, 10 deletions
diff --git a/helix-term/src/compositor.rs b/helix-term/src/compositor.rs index 6b39bb62..0e6a313d 100644 --- a/helix-term/src/compositor.rs +++ b/helix-term/src/compositor.rs @@ -178,13 +178,13 @@ pub trait AnyComponent { /// Returns a boxed any from a boxed self. /// /// Can be used before `Box::downcast()`. - /// - /// # Examples - /// - /// ```rust - /// // let boxed: Box<Component> = Box::new(TextComponent::new("text")); - /// // let text: Box<TextComponent> = boxed.as_boxed_any().downcast().unwrap(); - /// ``` + // + // # Examples + // + // ```rust + // let boxed: Box<Component> = Box::new(TextComponent::new("text")); + // let text: Box<TextComponent> = boxed.as_boxed_any().downcast().unwrap(); + // ``` fn as_boxed_any(self: Box<Self>) -> Box<dyn Any>; } diff --git a/helix-tui/src/lib.rs b/helix-tui/src/lib.rs index 0d466f8b..05263bc8 100644 --- a/helix-tui/src/lib.rs +++ b/helix-tui/src/lib.rs @@ -44,7 +44,7 @@ //! implement your own. //! //! Each widget follows a builder pattern API providing a default configuration along with methods -//! to customize them. The widget is then rendered using the [`Frame::render_widget`] which take +//! to customize them. The widget is then rendered using the `Frame::render_widget` which take //! your widget instance an area to draw to. //! //! The following example renders a block of the size of the terminal: diff --git a/helix-tui/src/widgets/mod.rs b/helix-tui/src/widgets/mod.rs index e334b894..484ad50e 100644 --- a/helix-tui/src/widgets/mod.rs +++ b/helix-tui/src/widgets/mod.rs @@ -1,4 +1,4 @@ -//! `widgets` is a collection of types that implement [`Widget`] or [`StatefulWidget`] or both. +//! `widgets` is a collection of types that implement [`Widget`]. //! //! All widgets are implemented using the builder pattern and are consumable objects. They are not //! meant to be stored but used as *commands* to draw common figures in the UI. diff --git a/helix-view/src/document.rs b/helix-view/src/document.rs index 4d5a23b6..fd127e1b 100644 --- a/helix-view/src/document.rs +++ b/helix-view/src/document.rs @@ -165,7 +165,7 @@ pub fn fold_home_dir(path: &Path) -> PathBuf { /// [`std::fs::canonicalize`] can be hard to use correctly, since it can often /// fail, or on Windows returns annoying device paths. This is a problem Cargo /// needs to improve on. -/// Copied from cargo: https://github.com/rust-lang/cargo/blob/070e459c2d8b79c5b2ac5218064e7603329c92ae/crates/cargo-util/src/paths.rs#L81 +/// Copied from cargo: <https://github.com/rust-lang/cargo/blob/070e459c2d8b79c5b2ac5218064e7603329c92ae/crates/cargo-util/src/paths.rs#L81> pub fn normalize_path(path: &Path) -> PathBuf { let path = expand_tilde(path); let mut components = path.components().peekable(); |