diff --git a/crates/gpui/src/color.rs b/crates/gpui/src/color.rs index e2d6d199f82feae8ea0b079370d8bbf817ae6348..e76c31d6f15db5a7690aab3bafd0b950f79e2824 100644 --- a/crates/gpui/src/color.rs +++ b/crates/gpui/src/color.rs @@ -40,7 +40,7 @@ impl fmt::Debug for Rgba { impl Rgba { /// Create a new [`Rgba`] color by blending this and another color together - /// TODO: find the source for this algorithm + /// TODO!(docs): find the source for this algorithm pub fn blend(&self, other: Rgba) -> Self { if other.a >= 1.0 { other diff --git a/crates/gpui/src/elements/div.rs b/crates/gpui/src/elements/div.rs index 6bfdbde10f9457df97eadb8e4c73355e7beb17ee..624630404c9393dce5887fb9a551245c1c90091f 100644 --- a/crates/gpui/src/elements/div.rs +++ b/crates/gpui/src/elements/div.rs @@ -18,7 +18,7 @@ //! # Capturing and bubbling //! //! Note that while event dispatch in GPUI uses similar names and concepts to the web -//! even API, the details are very different. See the documentation in [TODO +//! even API, the details are very different. See the documentation in [TODO!(docs) //! DOCUMENT EVENT DISPATCH SOMEWHERE IN WINDOW CONTEXT] for more details //! diff --git a/crates/gpui/src/gpui.rs b/crates/gpui/src/gpui.rs index 5bdece07e7b6e9b9ebcb64f43c06cad47dbdb9e4..954460e856dfe72b164c4f0fe20a8446acf9c4c8 100644 --- a/crates/gpui/src/gpui.rs +++ b/crates/gpui/src/gpui.rs @@ -1,6 +1,6 @@ //! # Welcome to GPUI! //! -//! GPUI is a hybrid immedate and retained mode, GPU accelerated, UI framework +//! GPUI is a hybrid immediate and retained mode, GPU accelerated, UI framework //! for Rust, designed to support a wide variety of applications. GPUI is currently //! being actively developed and improved for the [Zed code editor](https://zed.dev/), and new versions //! will have breaking changes. You'll probably need to use the latest stable version @@ -8,26 +8,24 @@ //! //! # Getting started with GPUI //! -//! TODO: Write a code sample showing how to create a window and render a simple +//! TODO!(docs): Write a code sample showing how to create a window and render a simple //! div //! //! # Drawing interesting things //! -//! TODO: Expand demo to show how to draw a more interesting scene, with +//! TODO!(docs): Expand demo to show how to draw a more interesting scene, with //! a counter to store state and a button to increment it. //! //! # Interacting with your application state //! -//! TODO: Expand demo to show GPUI entity interactions, like subscriptions and entities +//! TODO!(docs): Expand demo to show GPUI entity interactions, like subscriptions and entities //! maybe make a network request to show async stuff? //! //! # Conclusion //! -//! TODO: Wrap up with a conclusion and links to other places? Zed / GPUI website? +//! TODO!(docs): Wrap up with a conclusion and links to other places? Zed / GPUI website? //! Discord for chatting about it? Other tutorials or references? -#![deny(missing_docs)] - #[macro_use] mod action; mod app; diff --git a/crates/gpui/src/keymap/context.rs b/crates/gpui/src/keymap/context.rs index 8d2ddbb63d24a3384a95c7e4d4fddd75a2963051..05ef67ba2bc9d260215fc0df89a8a6e3039450f5 100644 --- a/crates/gpui/src/keymap/context.rs +++ b/crates/gpui/src/keymap/context.rs @@ -29,7 +29,7 @@ impl KeyContext { /// The key context format is very simple: /// - either a single identifier, such as `StatusBar` /// - or a key value pair, such as `mode = visible` - /// - seperated by whitespace, such as `StatusBar mode = visible` + /// - separated by whitespace, such as `StatusBar mode = visible` pub fn parse(source: &str) -> Result { let mut context = Self::default(); let source = skip_whitespace(source); diff --git a/crates/gpui/src/test.rs b/crates/gpui/src/test.rs index d8c81d52b8503ab719b5621caae8ee74841e454f..77540704f9c9e2543b102a3ee352570b144d62f2 100644 --- a/crates/gpui/src/test.rs +++ b/crates/gpui/src/test.rs @@ -34,7 +34,7 @@ use std::{ panic::{self, RefUnwindSafe}, }; -/// Run the given test function with the confifured paremeters. +/// Run the given test function with the configured parameters. /// This is intended for use with the `gpui::test` macro /// and generally should not be used directly. pub fn run_test(