Skip to content

Commit

Permalink
Remove redundant doc links
Browse files Browse the repository at this point in the history
Summary:
Otherwise we get lots of log spam like the below. Not a massive problem, but might as well clean up.

```
warning: redundant explicit link target
  --> gazebo/dupe/src/lib.rs:28:70
   |
28 | /// Like [`Clone`](Clone), but should only be available if [`Clone`](Clone) is
   |                                                             -------  ^^^^^ explicit target is redundant
   |                                                             |
   |                                                             because label contains path that resolves to same destination
   |
   = note: when a link's destination is not specified,
           the label is used to resolve intra-doc links
help: remove explicit link target
   |
28 | /// Like [`Clone`](Clone), but should only be available if [`Clone`] is
   |                                                            ~~~~~~~~~
```

Reviewed By: wendy728

Differential Revision: D52295432

fbshipit-source-id: 44b17ba7e536198bc4c5d6c134c7660c5d165366
  • Loading branch information
ndmitchell authored and facebook-github-bot committed Dec 19, 2023
1 parent f3b739c commit 05e0751
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions src/components/alignment.rs
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ pub enum HorizontalAlignmentKind {
Right,
}

/// The [`Aligned`](Aligned) [`Component`](Component) can be used to specify in which part of the view the content should live.
/// The [`HorizontalAlignmentKind`](HorizontalAlignmentKind) enum specifies the location relative to the x-axis.
/// The [`VerticalAlignmentKind`](VerticalAlignmentKind) enum specified the location relative to the y-axis.
/// The [`Aligned`] [`Component`] can be used to specify in which part of the view the content should live.
/// The [`HorizontalAlignmentKind`] enum specifies the location relative to the x-axis.
/// The [`VerticalAlignmentKind`] enum specified the location relative to the y-axis.
#[derive(Debug)]
pub struct Aligned<C: Component = Box<dyn Component>> {
pub child: C,
Expand Down
2 changes: 1 addition & 1 deletion src/components/padding.rs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ use crate::components::DrawMode;
use crate::Component;
use crate::Lines;

/// The `Padded` [`Component`](Component) wraps its child by padding left, right, above, and below its content.
/// The `Padded` [`Component`] wraps its child by padding left, right, above, and below its content.
/// This can be used to shift the content to a different location and ensure that following content comes after a certain distance.
/// It is worth noting that this component will also *truncate* any content that is too long to fit in the given window at draw time.
/// However, components are expected to constrain themselves to the given window, anyway.
Expand Down
6 changes: 3 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
*/

//! The superconsole crate provides a handler and building blocks for powerful, yet minimally intrusive TUIs.
//! Built on-top of [`crossterm`](crossterm), it cross-compiles on Windows 7+, Linux, and MacOS.
//! Built on-top of [`crossterm`], it cross-compiles on Windows 7+, Linux, and MacOS.
//!
//! Rendering is handled by [`SuperConsole`](SuperConsole), which draws to [`stdout`](std::io::stdout).
//! Rendering is handled by [`SuperConsole`], which draws to [`stdout`](std::io::stdout).
//! The caller is responsible for re-rendering whenever necessary.
//! User input will cause aberrations in output; similarly, one should also not produce output from other sources while superconsole is active.
//!
Expand All @@ -19,7 +19,7 @@
//! * In the *emitted* area, lines scroll away above the scratch with various diagnostic output.
//! Components live in the scratch area.
//!
//! A set of pre-baked composition and testing oriented components are provided in the [`components`](components) module.
//! A set of pre-baked composition and testing oriented components are provided in the [`components`] module.

pub use components::Component;
pub use components::DrawMode;
Expand Down

0 comments on commit 05e0751

Please sign in to comment.