diff --git a/.typos.toml b/.typos.toml index a63425b657c4..1786167ca30b 100644 --- a/.typos.toml +++ b/.typos.toml @@ -7,6 +7,7 @@ extend-exclude = [ ".typos.toml", "crates/re_ui/data/design_tokens.json", "crates/re_ui/src/design_tokens.rs", + "docs/cspell.json", "examples/assets", "rerun_cpp/src/rerun/third_party/cxxopts.hpp", ] @@ -109,6 +110,7 @@ saviour = "savior" savour = "savor" sceptical = "skeptical" sceptre = "scepter" +FUL = "FUL" # forward-up-left coordinate system sepulchre = "sepulcher" serialisation = "serialization" serialise = "serialize" @@ -127,8 +129,10 @@ tonne = "ton" travelogue = "travelog" tumour = "tumor" valour = "valor" +opf = "opf" # Open Photogrammetry Format (OPF) file vaporise = "vaporize" vigour = "vigor" +ws = "ws" # web-sockets, as in "ws://…" # null-terminated is the name of the wikipedia article! # https://en.wikipedia.org/wiki/Null-terminated_string @@ -137,9 +141,17 @@ zeroterminated = "null-terminated" zero-terminated = "null-terminated" [default] -# Work around for typos inside of hashes. These show up inside of ipynb. -# e.g. "f4e1caf9" -> `caf` should be `calf` -# Specifically limit ourselves to exactly 8 chars in a quoted string, or -# 16 character hashses following a leading underscore. -# Just don't spell "defaced" wrong. -extend-ignore-re = ["\"[a-f0-9]{8}\"", "_[a-f0-9]{16}"] +extend-ignore-re = [ + # Work around for typos inside of hashes. These show up inside of ipynb. + # e.g. "f4e1caf9" -> `caf` should be `calf` + # Specifically limit ourselves to exactly 8 chars in a quoted string, or + # 16 character hashses following a leading underscore. + # Just don't spell "defaced" wrong. + "\"[a-f0-9]{8}\"", + "_[a-f0-9]{16}", + + + "np.arange", # numpy spells "arrange" wrong + "phc_[a-zA-Z0-9]*", # Posthog public key + "PNG.?", # Workaround for https://github.com/crate-ci/typos/issues/967 +] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49f720671259..38cb6ce21e08 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -113,7 +113,7 @@ cargo run -p rerun -- --help ## Tools -We use the [`just`](https://github.com/casey/just) command runner tool for repository automation. See [here](https://github.com/casey/just#installation) for installation instructions. To see available automations, use `just --list`. +We use the [`just`](https://github.com/casey/just) command runner tool for repository automation. See [here](https://github.com/casey/just#installation) for installation instructions. To see available automation, use `just --list`. We use [cargo cranky](https://github.com/ericseppanen/cargo-cranky) and specify our clippy lints in [`Cranky.toml`](Cranky.toml). Usage: `cargo cranky`. diff --git a/crates/re_renderer/shader/outlines/jumpflooding_init_shared.wgsl b/crates/re_renderer/shader/outlines/jumpflooding_init_shared.wgsl index 98851acb6736..b0807413b438 100644 --- a/crates/re_renderer/shader/outlines/jumpflooding_init_shared.wgsl +++ b/crates/re_renderer/shader/outlines/jumpflooding_init_shared.wgsl @@ -2,7 +2,7 @@ #import <../screen_triangle_vertex.wgsl> fn compute_pixel_coords(center_coord: vec2i, unnormalized_edge_pos_a_and_b: vec4f, num_edges_a_and_b: vec2f) -> vec4f { - // Normalize edges ans get range from [0, 1] to [-0.5, 0.5]. + // Normalize edges and get range from [0, 1] to [-0.5, 0.5]. let edge_pos_a_and_b = unnormalized_edge_pos_a_and_b / num_edges_a_and_b.xxyy - vec4f(0.5); // We're outputting pixel coordinates (0-res) instead of texture coordinates (0-1). diff --git a/crates/re_types/src/components/view_coordinates_ext.rs b/crates/re_types/src/components/view_coordinates_ext.rs index f20d551b3101..9637441db83a 100644 --- a/crates/re_types/src/components/view_coordinates_ext.rs +++ b/crates/re_types/src/components/view_coordinates_ext.rs @@ -12,7 +12,7 @@ impl ViewCoordinates { Self([x as u8, y as u8, z as u8]) } - /// Choses a coordinate system based on just an up-axis. + /// Chooses a coordinate system based on just an up-axis. pub fn from_up_and_handedness(up: SignedAxis3, handedness: Handedness) -> Self { use ViewDir::{Back, Down, Forward, Right, Up}; match handedness { diff --git a/crates/re_types_builder/src/codegen/cpp/mod.rs b/crates/re_types_builder/src/codegen/cpp/mod.rs index 1c48d66edfb3..de1e378d6364 100644 --- a/crates/re_types_builder/src/codegen/cpp/mod.rs +++ b/crates/re_types_builder/src/codegen/cpp/mod.rs @@ -274,7 +274,7 @@ fn generate_object_files( /// /// Additionally, picks up all includes files that aren't including the header itself. /// -/// Returns what to inject, and what to repalce `HEADER_EXTENSION_TOKEN` with at the end. +/// Returns what to inject, and what to replace `HEADER_EXTENSION_TOKEN` with at the end. fn hpp_type_extensions( folder_path: &Utf8Path, filename_stem: &str, diff --git a/crates/re_ui/examples/re_ui_example.rs b/crates/re_ui/examples/re_ui_example.rs index 575b2482fa1b..abdc8c276628 100644 --- a/crates/re_ui/examples/re_ui_example.rs +++ b/crates/re_ui/examples/re_ui_example.rs @@ -187,7 +187,7 @@ impl eframe::App for ExampleApp { // no need to extend `ui.max_rect()` as the enclosing frame doesn't have margins ui.set_clip_rect(ui.max_rect()); - egui::TopBottomPanel::top("left_panel_tio_bar") + egui::TopBottomPanel::top("left_panel_top_bar") .exact_height(re_ui::ReUi::title_bar_height()) .frame(egui::Frame { inner_margin: egui::Margin::symmetric(re_ui::ReUi::view_padding(), 0.0), @@ -830,7 +830,7 @@ mod hierarchical_drag_and_drop { target_position_index: usize, }, - /// Specify the currently identifed target container to be highlighted. + /// Specify the currently identified target container to be highlighted. HighlightTargetContainer(ItemId), } diff --git a/crates/re_viewer/src/screenshotter.rs b/crates/re_viewer/src/screenshotter.rs index 99600500b6fb..cad6ed3da1fc 100644 --- a/crates/re_viewer/src/screenshotter.rs +++ b/crates/re_viewer/src/screenshotter.rs @@ -14,7 +14,7 @@ pub struct Screenshotter { #[cfg(not(target_arch = "wasm32"))] #[must_use] pub struct ScreenshotterOutput { - /// If true, the screenshotter was told at startup to quit after its donw. + /// If true, the screenshotter was told at startup to quit after it's done. pub quit: bool, } diff --git a/rerun_cpp/download_and_build_arrow.cmake b/rerun_cpp/download_and_build_arrow.cmake index d6c763313e5c..59cf734d937a 100644 --- a/rerun_cpp/download_and_build_arrow.cmake +++ b/rerun_cpp/download_and_build_arrow.cmake @@ -73,7 +73,7 @@ function(download_and_build_arrow) GIT_REPOSITORY https://github.com/apache/arrow.git GIT_TAG apache-arrow-10.0.1 GIT_SHALLOW ON - GIT_PROGRESS OFF # Git progress sounds like a nice idea but is in practive very spammy. + GIT_PROGRESS OFF # Git progress sounds like a nice idea but is in practice very spammy. # LOG_X ON means that the output of the command will # be logged to a file _instead_ of printed to the console.