Assorted spelling, grammar, and casing fixes to comments and strings (#162)

Co-authored-by: Mitch Davis <mjd@afork.com>

Author: CapnKernel

README.md

@@ -28,7 +28,7 @@ KiCanvas is very early in its development and there's a ton of stuff that hasn't
 
 ## Known issues
 
-In general, please check the [GitHub issues] page before filing new issues. Some high-level things that we known won't work:
+In general, please check the [GitHub issues] page before filing new issues. Some high-level things that we know won't work:
 
 - Any KiCAD 5 files, KiCanvas can only parse files from KiCAD 6 and later.
 - Some KiCAD 7 features might not be fully implemented, such as custom fonts in schematics.

docs/docs/license.md

@@ -33,7 +33,7 @@ derivative works.
 
 This project contains copies or makes use of other works. These works and their respective license and terms are:
 
-- Earcut by Mapbox, licensed under the ISC license. Retrived from https://github.com/mapbox/earcut.
+- Earcut by Mapbox, licensed under the ISC license. Retrieved from https://github.com/mapbox/earcut.
 - Newstroke by Vladimir Uryvaev, Lingdong Huang, Adobe, and KiCAD contributors. Originally licensed under Creative Commons CC0 1.0, amended with an MIT-like license, and utilizes glyphs that are licensed under the SIL Open Font License Version 1.1.
 - Material Symbols by Google, licensed under the Apache License, Version 2.0. Retrieved from https://github.com/google/material-design-icons.
 - Nunito by Vernon Adams, Manvel Shmavonyan, licensed under the Open Font License. Retrieved from https://fonts.google.com/specimen/Nunito/about

src/base/dom/size-observer.ts

@@ -9,7 +9,7 @@ import type { IDisposable } from "../disposable";
 type ResizeObserverCallback = (target: HTMLElement) => void;
 
 /**
- * Wrapper over ResizeObserver that implmenets IDisposable
+ * Wrapper over ResizeObserver that implements IDisposable
  */
 export class SizeObserver implements IDisposable {
     #observer: ResizeObserver;

src/base/events.ts

@@ -7,7 +7,7 @@
 import type { IDisposable } from "./disposable";
 
 /**
- * Adds an event listener and wraps it as a Disposable. When disposed, the
+ * Adds an event listener and wraps it as a Disposable. When disposed of, the
  * event listener is removed from the target.
  */
 export function listen<K extends keyof GlobalEventHandlersEventMap>(

src/base/math/angle.ts

@@ -84,7 +84,7 @@ export class Angle {
     }
 
     /**
-     * Returns a new Angle representing the different of this angle and the given angle.
+     * Returns a new Angle representing the difference between this angle and the given angle.
      */
     sub(other: AngleLike) {
         const diff = this.radians - new Angle(other).radians;

src/base/math/arc.ts

@@ -47,7 +47,7 @@ export class Arc {
         const mid_angle = mid.sub(center).angle;
         const end_angle = end.sub(center).angle;
 
-        // calcuate the arc angle
+        // calculate the arc angle
         let arc_angle;
         const start_to_mid = mid_angle.sub(start_angle).normalize();
         const start_to_end = end_angle.sub(start_angle).normalize();
@@ -60,8 +60,8 @@ export class Arc {
             arc_angle = Angle.from_degrees(360).sub(start_to_end);
         }
 
-        // although kicad always create a clockwise arc,
-        // but we can import a counter-clockwise arc from other EDA/CAD using KiCad
+        // although KiCad always creates clockwise arcs, the file may contain
+        // counter-clockwise arcs through imports from other EDA/CAD programs
         let arc_start;
         let direction: ArcDirection;
 

src/base/math/bbox.ts

@@ -110,7 +110,7 @@ export class BBox {
     }
 
     /**
-     * @returns true if the bbox has a non-zero area
+     * @returns true if the BBox has a non-zero area
      */
     get valid() {
         return (

src/base/math/camera2.ts

@@ -106,7 +106,7 @@ export class Camera2 {
     }
 
     /**
-     * Apply this camera to a 2d canvas
+     * Apply this camera to a 2D canvas
      *
      * A simple convenience method that sets the canvas's transform to
      * the camera's transformation matrix.

src/base/math/matrix3.ts

@@ -88,7 +88,7 @@ export class Matrix3 {
     }
 
     /**
-     * @returns a new matrix representing a 2d orthographic projection
+     * @returns a new matrix representing a 2D orthographic projection
      */
     static orthographic(width: number, height: number): Matrix3 {
         // prettier-ignore
@@ -147,7 +147,7 @@ export class Matrix3 {
     }
 
     /**
-     * Transforms a list of vector by a given matrix, which may be null.
+     * Transforms a list of vectors by a given matrix, which may be null.
      */
     static transform_all(mat: Matrix3 | null, vecs: Vec2[]): Vec2[] {
         if (!mat) {
@@ -237,7 +237,7 @@ export class Matrix3 {
     }
 
     /**
-     * @returns A new matrix representing a 2d translation
+     * @returns A new matrix representing a 2D translation
      */
     static translation(x: number, y: number): Matrix3 {
         // prettier-ignore
@@ -265,7 +265,7 @@ export class Matrix3 {
     }
 
     /**
-     * @returns {Matrix3} A new matrix representing a 2d scale
+     * @returns {Matrix3} A new matrix representing a 2D scale
      */
     static scaling(x: number, y: number): Matrix3 {
         // prettier-ignore
@@ -293,7 +293,7 @@ export class Matrix3 {
     }
 
     /**
-     * @returns A new matrix representing a 2d rotation
+     * @returns A new matrix representing a 2D rotation
      */
     static rotation(angle: AngleLike): Matrix3 {
         const theta = new Angle(angle).radians;

src/base/web-components/decorators.ts

@@ -67,7 +67,7 @@ const default_attribute_converter = {
                 return `${value}`;
             default:
                 throw new Error(
-                    `Can not convert type "${type}" and value "${value} to attribute`,
+                    `Cannot convert type "${type}" and value "${value} to attribute`,
                 );
         }
     },
@@ -81,7 +81,7 @@ const default_attribute_converter = {
                 return value === null ? null : Number(value);
             default:
                 throw new Error(
-                    `Can not convert type "${type}" and value "${value} to attribute`,
+                    `Cannot convert type "${type}" and value "${value} to attribute`,
                 );
         }
     },