Skip to content

Commit

Permalink
Fix broken intra-doc links to Sandbox
Browse files Browse the repository at this point in the history
  • Loading branch information
hecrj committed Mar 17, 2024
1 parent 846d76c commit 179e886
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 13 deletions.
4 changes: 1 addition & 3 deletions src/application.rs
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ pub use application::{default, Appearance, DefaultStyle};
/// document.
///
/// An [`Application`] can execute asynchronous actions by returning a
/// [`Command`] in some of its methods. If you do not intend to perform any
/// background work in your program, the [`Sandbox`] trait offers a simplified
/// interface.
/// [`Command`] in some of its methods.
///
/// When using an [`Application`] with the `debug` feature enabled, a debug view
/// can be toggled by pressing `F12`.
Expand Down
16 changes: 12 additions & 4 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,20 +134,28 @@
//! }
//! ```
//!
//! And that's everything! We just wrote a whole user interface. Iced is now
//! able to:
//! And that's everything! We just wrote a whole user interface. Let's run it:
//!
//! ```no_run
//! fn main() -> iced::Result {
//! iced::run("A cool counter", Counter::update, Counter::view)
//! }

Check failure on line 142 in src/lib.rs

View workflow job for this annotation

GitHub Actions / all (ubuntu-latest, stable)

failed to resolve: use of undeclared type `Counter`

Check failure on line 142 in src/lib.rs

View workflow job for this annotation

GitHub Actions / all (ubuntu-latest, stable)

failed to resolve: use of undeclared type `Counter`

Check failure on line 142 in src/lib.rs

View workflow job for this annotation

GitHub Actions / all (ubuntu-latest, beta)

failed to resolve: use of undeclared type `Counter`

Check failure on line 142 in src/lib.rs

View workflow job for this annotation

GitHub Actions / all (ubuntu-latest, beta)

failed to resolve: use of undeclared type `Counter`

Check failure on line 142 in src/lib.rs

View workflow job for this annotation

GitHub Actions / all (macOS-latest, stable)

failed to resolve: use of undeclared type `Counter`

Check failure on line 142 in src/lib.rs

View workflow job for this annotation

GitHub Actions / all (macOS-latest, stable)

failed to resolve: use of undeclared type `Counter`
//! ```
//!
//! Iced will automatically:
//!
//! 1. Take the result of our __view logic__ and layout its widgets.
//! 1. Process events from our system and produce __messages__ for our
//! __update logic__.
//! 1. Draw the resulting user interface.
//!
//! # Usage
//! The [`Application`] and [`Sandbox`] traits should get you started quickly,
//! streamlining all the process described above!
//! You can either use the [`application`] builder or implement the [`Application`]
//! trait directly.
//!
//! [Elm]: https://elm-lang.org/
//! [The Elm Architecture]: https://guide.elm-lang.org/architecture/
//! [`application`]: application()
#![doc(
html_logo_url = "https://raw.githubusercontent.com/iced-rs/iced/9ab6923e943f784985e9ef9ca28b10278297225d/docs/logo.svg"
)]
Expand Down
4 changes: 1 addition & 3 deletions src/multi_window.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,7 @@ pub use crate::application::{Appearance, DefaultStyle};
/// document and display only the contents of the `window::Id::MAIN` window.
///
/// An [`Application`] can execute asynchronous actions by returning a
/// [`Command`] in some of its methods. If you do not intend to perform any
/// background work in your program, the [`Sandbox`] trait offers a simplified
/// interface.
/// [`Command`] in some of its methods.
///
/// When using an [`Application`] with the `debug` feature enabled, a debug view
/// can be toggled by pressing `F12`.
Expand Down
4 changes: 1 addition & 3 deletions src/program.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
//! or a specific type.
//!
//! This API is meant to be a more convenient—although less
//! powerful—alternative to the [`Sandbox`] and [`Application`] traits.
//! powerful—alternative to the [`Application`] traits.
//!
//! [`Sandbox`]: crate::Sandbox
//!
Expand Down Expand Up @@ -748,8 +748,6 @@ fn with_style<P: Definition>(
///
/// This trait is implemented both for `&static str` and
/// any closure `Fn(&State) -> String`.
///
/// You can use any of these in [`Program::title`].
pub trait Title<State> {
/// Produces the title of the [`Program`].
fn title(&self, state: &State) -> String;
Expand Down

0 comments on commit 179e886

Please sign in to comment.