Fix typos, grammar, and spelling mistakes

[BenjaminBrienen]

Objective

Code and documentation should use words that exist and are spelled correctly.

Also, I noticed a markdownlint warning to do with the table at the bottom having left and right bars (inconsistent style) so I fixed the template file.

Solution

I used the cSpell VS Code extension and literally opened every single .rs file to see if it popped up any cSpell "Problems". Most of them were added as "words" in settings.json. See here:

  "cSpell.words": [
    "Aabb",
    "aabbs",
    "Aaltonen's",
    "aarch",
    "Abney",
    "accesskit",
    "acosf",
    "acosh",
    "acoshf",
    "adjwgt",
    "Adreno",
    "ahash",
    "allocvec",
    "animatable",
    "animgraph",
    "antialiasing",
    "anymap",
    "anytuple",
    "aortiz",
    "APPCOMMAND",
    "arctan",
    "argb",
    "argh",
    "arity",
    "arrayvec",
    "artifacting",
    "asinf",
    "asinh",
    "asinhf",
    "astc",
    "atanf",
    "atanh",
    "atanhf",
    "atomicow",
    "autovectorization",
    "AZERTY",
    "backface",
    "Backfaces",
    "Backquote",
    "backshift",
    "barebones",
    "baricenter",
    "barycentrics",
    "batchable",
    "batchables",
    "bevyengine",
    "bevymark",
    "Bezier",
    "Bézier",
    "Beziers",
    "Bezold",
    "Bgra",
    "bilinearly",
    "bincode",
    "bindgen",
    "bindgroup",
    "bindgroups",
    "Bindless",
    "bindpose",
    "bindposes",
    "bitand",
    "bitangent",
    "bitcast",
    "bitfield",
    "Bitfields",
    "bitflags",
    "bitflip",
    "Bitmask",
    "bitsets",
    "bitshifted",
    "bitslice",
    "bitstream",
    "bitvec",
    "BLIT",
    "blobby",
    "bokeh",
    "Borderless",
    "Brücke",
    "BSDF",
    "bsparse",
    "Bufferable",
    "bufread",
    "buildable",
    "BURLYWOOD",
    "bytemuck",
    "bytewise",
    "callables",
    "callstack",
    "canonicalize",
    "castable",
    "Castano",
    "Castaño",
    "Casteljau",
    "catmull",
    "cbrt",
    "cbrtf",
    "chacha",
    "cheatbook",
    "chipsets",
    "Choi",
    "CIEXYY",
    "CIEXYZ",
    "cinematics",
    "circumcenter",
    "circumcircle",
    "circumradius",
    "clearcoat",
    "Cloneable",
    "Clusterable",
    "cmpeq",
    "cmpge",
    "cmpgt",
    "cmple",
    "CMYKA",
    "codegen",
    "combinators",
    "componentless",
    "componentwise",
    "constness",
    "consts",
    "cooldown",
    "copysign",
    "CORNSILK",
    "cosf",
    "coshf",
    "cpus",
    "criss",
    "crossfading",
    "cubemap",
    "CUBEMAPS",
    "dasharray",
    "ddsfile",
    "deadzone",
    "dealloc",
    "Deband",
    "debanding",
    "Debouncer",
    "defaultable",
    "denoise",
    "denoised",
    "Denoising",
    "denormalization",
    "denormalized",
    "dereferenceable",
    "derefs",
    "desaturate",
    "desaturated",
    "desaturates",
    "desaturation",
    "deserializers",
    "Desmos",
    "despawn",
    "despawned",
    "despawning",
    "despawns",
    "Destructures",
    "discoverability",
    "docsrs",
    "docstrings",
    "doctest",
    "doubletap",
    "downcasted",
    "downcasting",
    "downsample",
    "downsampling",
    "downscaling",
    "dpad",
    "dropck",
    "dvec",
    "Dwarnings",
    "Dxgi",
    "dxil",
    "dylib",
    "easings",
    "Eevee",
    "ehttpd",
    "Eisu",
    "elerp",
    "ENDCALL",
    "endfor",
    "endianness",
    "ERCIM",
    "evaluateable",
    "expf",
    "expm",
    "eyepatch",
    "fabsf",
    "Farbfeld",
    "fieldless",
    "finalizer",
    "Fira",
    "fixedbitset",
    "fixint",
    "flac",
    "flate",
    "flatmap",
    "flexbox",
    "fontdb",
    "foos",
    "Footguns",
    "fract",
    "framebuffer",
    "Framelimit",
    "framerates",
    "frametime",
    "freecam",
    "freelist",
    "fullscreen",
    "fullsize",
    "FXAA",
    "gabe",
    "GAINSBORO",
    "gamedev",
    "gamepad",
    "gamepads",
    "gameplay",
    "gbuffer",
    "GFBD",
    "Gibibytes",
    "gilrs",
    "Gjøl",
    "Gles",
    "GLSL",
    "Gltf",
    "gltfs",
    "gradlew",
    "graphmap",
    "graymap",
    "Greenstein",
    "guillotiere",
    "Habib",
    "Halton",
    "Hanja",
    "Hankaku",
    "hashable",
    "hashbrown",
    "Hasher",
    "hashset",
    "HEADSETHOOK",
    "henkan",
    "Henyey",
    "hexasphere",
    "hittest",
    "HLOD",
    "HLODs",
    "HLSL",
    "hotspot",
    "hoverable",
    "HRTF",
    "Hwba",
    "hypot",
    "hypotf",
    "icosphere",
    "idents",
    "ifdef",
    "ifndef",
    "ilog",
    "IMEs",
    "impls",
    "injective",
    "inlabel",
    "inradius",
    "inscattering",
    "insource",
    "interactable",
    "Internable",
    "INTERNER",
    "interp",
    "irect",
    "irreflexivity",
    "itertools",
    "Junja",
    "Kaihuai",
    "keybinds",
    "keycodes",
    "keydown",
    "keysym",
    "keysyms",
    "Khronos",
    "Koschmieder",
    "Kummer",
    "kway",
    "Laba",
    "Lambertian",
    "layouting",
    "Lcha",
    "legendaries",
    "Lengyel",
    "lerp",
    "libbevy",
    "libc",
    "libm",
    "libstd",
    "lifetimed",
    "lifetimeless",
    "Lightmap",
    "lightmapped",
    "Lightmapper",
    "lightmaps",
    "LIMEGREEN",
    "linebreak",
    "linebreaks",
    "linestrip",
    "livezone",
    "logcat",
    "logf",
    "łørđ",
    "losslessly",
    "lowerbound",
    "Luma",
    "luts",
    "Mapface",
    "markdownlint",
    "memmove",
    "mergeable",
    "Meshable",
    "meshlet",
    "meshlets",
    "meshopt",
    "metadatas",
    "metalness",
    "metas",
    "metavar",
    "midtone",
    "midtones",
    "Mikkelsen's",
    "Mikkelsen",
    "mikktspace",
    "milli",
    "millihertz",
    "minimaps",
    "minmax",
    "mipchain",
    "mipmap",
    "mipmapped",
    "mipmaps",
    "MIRI",
    "mixamo",
    "Moiré",
    "Moissanite",
    "monomorphization",
    "monomorphizations",
    "monomorphized",
    "Morten",
    "Morvan",
    "Msaa",
    "msrv",
    "msvc",
    "muhenkan",
    "multimonitor",
    "multiplicatively",
    "Multisample",
    "multisampled",
    "multisampling",
    "multitouch",
    "multiview",
    "mосква",
    "naïvely",
    "namespacing",
    "nand",
    "Nanite",
    "nanos",
    "natvis",
    "NEGATIVEX",
    "NEGATIVEY",
    "NEGATIVEZ",
    "Nesw",
    "Neubelt",
    "newtype",
    "NEXTTRACK",
    "nlerp",
    "nocheck",
    "nonmax",
    "nonminimal",
    "Nonnegativity",
    "nonoverlapping",
    "nonplaying",
    "nonprimary",
    "nonsend",
    "nonsendmut",
    "nonspatial",
    "Nout",
    "Numpad",
    "NURB",
    "Nurbs",
    "OCIO",
    "Oklab",
    "Oklaba",
    "Oklch",
    "Oklcha",
    "OLIVEGREEN",
    "oneshot",
    "openexr",
    "orthogonalization",
    "orthonormalization",
    "orthonormalize",
    "oslog",
    "oversaturates",
    "parallaxed",
    "parallaxing",
    "parameterizations",
    "parameterless",
    "parentless",
    "Pathing",
    "PCSS",
    "PEACHPUFF",
    "peekable",
    "perp",
    "Persson",
    "pessimize",
    "petgraph",
    "Pettineo",
    "Pickable",
    "pickables",
    "PINP",
    "pixmap",
    "pointlight",
    "Polyline",
    "POSITIVEX",
    "POSITIVEY",
    "POSITIVEZ",
    "posterization",
    "postorder",
    "postprocess",
    "powf",
    "powi",
    "powsafe",
    "PQRS",
    "precomputations",
    "precompute",
    "Preedit",
    "Preëdit",
    "Prefilter",
    "preimage",
    "premultiply",
    "prepass",
    "prepasses",
    "preprocess",
    "preprocessable",
    "Preservering",
    "PREVIOUSTRACK",
    "PRNG",
    "procmacro",
    "procmacro2_semver_exempt",
    "Proto",
    "proxied",
    "proxying",
    "ptrs",
    "punct",
    "PVRTC",
    "qself",
    "quadro",
    "QWERTZ",
    "Radeon",
    "radsort",
    "RAII",
    "Rampon",
    "Raphson",
    "rasterizer",
    "rasterizing",
    "raycast",
    "Raycasting",
    "RAYMARCH",
    "raymarching",
    "raytracing",
    "RCAS",
    "rcvec",
    "readback",
    "readbacks",
    "realloc",
    "REBECCA",
    "rebindings",
    "reborrow",
    "reborrowed",
    "reborrowing",
    "reborrows",
    "recip",
    "recompiles",
    "rects",
    "redepend",
    "Reexit",
    "Reflectable",
    "Reflectstd",
    "reimplementation",
    "reindex",
    "Reinhard",
    "relayout",
    "renderable",
    "renormalize",
    "renormalized",
    "renormalizes",
    "renormalizing",
    "Reparam",
    "reparameterization",
    "reparameterizations",
    "reparameterize",
    "reparameterized",
    "reparent",
    "reparented",
    "reparenting",
    "reparsing",
    "repr",
    "requiree",
    "requirees",
    "reserialize",
    "resmut",
    "respawn",
    "retargeting",
    "retransformed",
    "rgba",
    "Rgba8Snorm",
    "Rgba8Unorm",
    "RGBSDA",
    "rngs",
    "rodio",
    "Romaji",
    "roundtripped",
    "roundtrips",
    "RRGGBB",
    "RRGGBBAA",
    "Rrrg",
    "rsplit",
    "runtimes",
    "rustc",
    "rustdoc",
    "RUSTDOCFLAGS",
    "rustfix",
    "RUSTFLAGS",
    "rustfmt",
    "Rustonomicon",
    "rustup",
    "ruzstd",
    "Ryfjallet",
    "samplable",
    "scancode",
    "scanline",
    "sccs",
    "Scratchapixel",
    "screenspace",
    "Seedable",
    "SFLOAT",
    "shadowmap",
    "sharedso",
    "shortnames",
    "Siggraph",
    "signum",
    "simctl",
    "SIMD",
    "simplespace",
    "sincosf",
    "sinf",
    "sinhf",
    "skippable",
    "Şķràźÿ",
    "skybox",
    "skyboxes",
    "slerp",
    "smaa",
    "smallvec",
    "smol_hyper",
    "smol_str",
    "SmolStr",
    "SmolTimer",
    "snorm",
    "Sobotka",
    "spacebar",
    "specializer",
    "specularly",
    "SPIR",
    "SPIRV",
    "splitn",
    "srgb",
    "srgba",
    "SSAA",
    "SSAO",
    "ssbo",
    "ssbos",
    "Stachowiak",
    "stackfuture",
    "steppable",
    "struct",
    "subapp",
    "subasset",
    "subaxis",
    "subcrate",
    "subcrates",
    "subdir",
    "subinterval",
    "subqueries",
    "subquery",
    "Subresource",
    "subspan",
    "substate",
    "substates",
    "subtest",
    "subtrait",
    "subtraits",
    "subtyping",
    "Supercompression",
    "superdump",
    "supertrait",
    "supertraits",
    "Svendsen",
    "swapchain",
    "synccell",
    "syncunsafecell",
    "sysinfo",
    "Tanasoaia",
    "tanf",
    "tanhf",
    "Tarjan",
    "Teodor",
    "tera",
    "TEXCOORD",
    "texel",
    "texels",
    "textureless",
    "thiserror",
    "thresholded",
    "thresholding",
    "Tiago",
    "Tickrate",
    "tileset",
    "timespan",
    "timestep",
    "timesteps",
    "titlebar",
    "Tomasz",
    "TONEMAP",
    "tonemapped",
    "tonemapper",
    "tonemappers",
    "Tonemapping",
    "tony_mc_mapface",
    "TonyMcMapface",
    "topsort",
    "touchpads",
    "transactionality",
    "tspan",
    "turbofish",
    "tweakable",
    "Typeless",
    "UASTC",
    "Ufloat",
    "UI's",
    "uinode",
    "uinodes",
    "uirect",
    "uistack",
    "Ulps",
    "ultrawide",
    "unaliased",
    "unassigning",
    "unbatchable",
    "unbatchables",
    "unbatched",
    "unboundedness",
    "unclipped",
    "unconstructable",
    "unfixable",
    "unflushed",
    "unforce",
    "ungrab",
    "unhandleable",
    "UNHOVERED",
    "uninit",
    "uniterated",
    "unjittered",
    "unmap",
    "unnormalized",
    "Unorm",
    "unpadded",
    "unproxied",
    "unsampled",
    "Unskewed",
    "unskinned",
    "unspilled",
    "unstretched",
    "unsuffixed",
    "unsynchronized",
    "untargeted",
    "UNTEXTURED",
    "unthrottled",
    "unwrapper",
    "unyielded",
    "upcasting",
    "upperbound",
    "Upsample",
    "upsampled",
    "upsampling",
    "upscaled",
    "upscaling",
    "urect",
    "ureq",
    "uvec",
    "UYVY",
    "Valorant's",
    "Vals",
    "variadics",
    "vblank",
    "VecDeque",
    "veclike",
    "vecs",
    "verlet",
    "viewports",
    "VIOLETRED",
    "virt",
    "Vlachos",
    "vorbis",
    "voxel",
    "voxelized",
    "voxels",
    "Vsync",
    "VTABLE",
    "Vulkan",
    "VXGI",
    "WAKEUP",
    "WASD",
    "webgl",
    "webgpu",
    "WGPU_SETTINGS_PRIO",
    "wgpu",
    "wgsl",
    "winit",
    "wireframe",
    "wireframes",
    "wlong",
    "workgroups",
    "worldspace",
    "writeback",
    "wshort",
    "WXYZ",
    "xcodeproj",
    "xcrun",
    "xffffffff",
    "xmag",
    "xnor",
    "xshell",
    "xvfb",
    "Xwayland",
    "Xyza",
    "xyzw",
    "ycbcr",
    "yeong",
    "yfov",
    "YIQSDA",
    "YUVSDA",
    "Zenkaku",
    "Zeroable",
    "zfar",
    "ZINDEX",
    "znear",
    "Zstandard"
  ],

Testing

The CI should be good.

Migration Guide

Color::rbga_linear -> Color::rgba_linear
CubicSegment.coeff -> CubicSegment.coefficients
RationalSegment.coeff -> RationalSegment.coefficients
RationalSegment.weight_coeff -> RationalSegment.weight_coefficients
Curve::reparameterize -> Curve::reparametrize
Curve::reparametrize_linear -> Curve::reparameterize_linear
Curve::reparametrize_by_curve -> Curve::reparameterize_by_curve
FallbackImageMsaa::image_for_samplecount -> FallbackImageMsaa::image_for_sample_count
prepare_uimaterial_nodes -> prepare_ui_material_nodes
GridTrack::vmin -> GridTrack::v_min
GridTrack::vmax -> GridTrack::v_max
ExitCondition::DontExit -> ExitCondition::DoNotExit
WinitWindows::get_fitting_videomode -> WinitWindows::get_fitting_video_mode
get_best_videomode -> get_best_video_mode
RepeatedGridTrack::vmin -> RepeatedGridTrack::v_min
RepeatedGridTrack::vmax -> RepeatedGridTrack::v_max

[github-actions]

The generated examples/README.md is out of sync with the example metadata in Cargo.toml or the example readme template. Please run cargo run -p build-templated-pages -- update examples to update it, and commit the file change.

[rparrett]

Mostly like these changes, but they should probably be held back until after the 0.15 release cycle is complete to avoid cherry-picking conflicts.

I am curious as to why typos didn't catch some of the more egregious stuff in CI.

Quite a few breaking changes. One is a super obvious typo that should definitely get fixed up. No opinion on others.

[BenjaminBrienen]

@rparrett I think I addressed all the feedback. Most of it was adding to the migration guide and applying your suggestions. Let me know if you have further comments! :)

[BenjaminBrienen]

I have submitted the basic English typos to the typos CI repository.

I can add the long list of exceptions to the typos.toml if wanted. I can comment an explanation for each one and I can make sure each one is in the proper category.