From 947bc6e48975d2b8185356bb9961bb4e903d6573 Mon Sep 17 00:00:00 2001 From: Frank Elsinga Date: Thu, 26 Sep 2024 01:11:46 +0800 Subject: [PATCH] made sure that the docs are not all over the place in terms of wording for this feature --- docs/src/sources-sprites.md | 6 +++--- martin/src/args/root.rs | 4 ++-- martin/src/sprites/mod.rs | 8 ++++---- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/src/sources-sprites.md b/docs/src/sources-sprites.md index 101e4c8ac..679b6d3d7 100644 --- a/docs/src/sources-sprites.md +++ b/docs/src/sources-sprites.md @@ -58,7 +58,7 @@ martin --sprite /path/to/sprite_a --sprite /path/to/other/sprite_b ``` To use generate Signed Distance Fields (SDFs) images instead, the `--make_sdf` Option can be added. -SDF-Images allow their color to be set at runtime in the map redering engine. +SDF Images allow their color to be set at runtime in the map rendering engine. ```bash martin --sprite /path/to/sprite_a --sprite /path/to/other/sprite_b --make_sdf @@ -78,8 +78,8 @@ sprites: sources: # SVG images in this directory will be published under the sprite_id "my_sprites" my_sprites: /path/to/some_dir - # This tells Martin to handle images in directories as Signed Distance Fields (SDFs) - # SDF-Images allow their color to be set at runtime in the map redering engine. + # Tells Martin to handle sprites as Signed Distance Fields (SDFs) + # SDF Images allow their color to be set at runtime in the map rendering engine. # Defaults to `false`. make_sdf: false ``` diff --git a/martin/src/args/root.rs b/martin/src/args/root.rs index ac3e5c41c..0ab29e3ee 100644 --- a/martin/src/args/root.rs +++ b/martin/src/args/root.rs @@ -59,8 +59,8 @@ pub struct ExtraArgs { /// Export a directory with SVG files as a sprite source. Can be specified multiple times. #[arg(short, long)] pub sprite: Vec, - /// tells Martin to handle images in directories as Signed Distance Fields (SDFs) - /// Images handled as a SDF allow their color to be set at runtime in the map redering enines. + /// Tells Martin to handle sprites as Signed Distance Fields (SDFs) + /// SDF Images allow their color to be set at runtime in the map rendering engine. /// /// Defaults to `false`. #[arg(long)] diff --git a/martin/src/sprites/mod.rs b/martin/src/sprites/mod.rs index 5d96f13b7..fd37d9413 100644 --- a/martin/src/sprites/mod.rs +++ b/martin/src/sprites/mod.rs @@ -60,8 +60,8 @@ pub type SpriteCatalog = BTreeMap; #[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)] pub struct SpriteConfig { - /// This tells Martin to handle images in directories as Signed Distance Fields (SDFs) - /// Images are handled as a signed-distance field (SDF) allow their color to be set at runtime in the map redering enines. + /// Tells Martin to handle sprites as Signed Distance Fields (SDFs) + /// SDF Images allow their color to be set at runtime in the map rendering engine. /// /// Defaults to `false`. pub make_sdf: bool, @@ -78,8 +78,8 @@ impl ConfigExtras for SpriteConfig { #[derive(Debug, Clone, Default)] pub struct SpriteSources { sources: HashMap, - /// This tells Martin to handle images in directories as Signed Distance Fields (SDFs) - /// Images are handled as a signed-distance field (SDF) allow their color to be set at runtime in the map redering enines. + /// Tells Martin to handle sprites as Signed Distance Fields (SDFs) + /// SDF Images allow their color to be set at runtime in the map rendering engine. /// /// Defaults to `false`. make_sdf: bool,