Tidy comments

Author: maneatingape

CONTRIBUTING.md

@@ -5,10 +5,9 @@ They're pretty fast and clean...but can you make them even *faster and cleaner*?
 
 If you've made an improvement, then please
 [open a pull request](https://github.com/maneatingape/advent-of-code-rust/compare).
-Contributions are encouraged and valued. ❤️
+Contributions are encouraged and valued. 🎁
 
-
-It should generally fall into one of the following two categories:
+Your contribution should generally fall into one of the following two categories:
 
 * 🪲 **Bug Fix** Solutions try to be as general as possible but can't test for every input.
   Your pull request fixes an incorrect answer for your input or prevents a panic.
@@ -27,13 +26,13 @@ may be provided under the project license.
 Pull requests should meet the following baseline standards:
 
 * Commit messages and pull request title are clear and informative.
-* Code style matches the existing code. This one is somewhat subjective but try to "fit in" by
+* Code style matches the existing code. This one is somewhat subjective, but try to "fit in" by
   using the same naming conventions. Code should be portable, avoiding any architecture
   specific intrinsics.
 * Unit tests pass.
 * Code is formatted using `rustfmt`.
 * Code is linted using `clippy`.
 
 Formatting and linting can be executed by running [`just`](https://github.com/casey/just)
-(if installed) on the command line at the project root, or alternatively copying and pasting
+(if installed) on the command line at the project root, or by copying and pasting
 the commands from [`justfile`](justfile) into the terminal.

src/year2018/day06.rs

@@ -73,7 +73,7 @@ pub fn part1(input: &Input) -> i32 {
                     let width = x1 - x0;
 
                     if delta < -width {
-                        // Left coordinate is further away at every points.
+                        // Left coordinate is further away at every point.
                         // Discard and pop next left coordinate from the stack.
                         //
                         //    rrrrrrrrrrrrrrrr     <-- Considering only this row

src/year2021/day11.rs

@@ -45,7 +45,7 @@ fn simulate(input: &Input, predicate: fn(usize, usize) -> bool) -> (usize, usize
     while predicate(flashes, steps) {
         flashes = 0;
 
-        // Bump each octopus' energy level by one. If it flashes then add to `todo` queue.
+        // Bump each octopus's energy level by one. If it flashes then add to `todo` queue.
         for y in 0..10 {
             for x in 0..10 {
                 let index = 12 * (y + 1) + (x + 1);

src/year2023/day03.rs

@@ -44,7 +44,7 @@ pub fn parse(input: &str) -> Input {
     Input { grid, seen, parts }
 }
 
-/// Sum all part numbers adjacent to a least one symbol.
+/// Sum all part numbers adjacent to at least one symbol.
 pub fn part1(input: &Input) -> u32 {
     let Input { grid, seen, parts } = input;
     let mut parts = parts.clone();
@@ -60,7 +60,7 @@ pub fn part1(input: &Input) -> u32 {
                     let index = seen[p + d];
                     if index != 0 {
                         result += parts[index];
-                        // Only count each number once when its adjacent to multiple symbols.
+                        // Only count each number once when it is adjacent to multiple symbols.
                         parts[index] = 0;
                     }
                 }

src/year2024/day04.rs

@@ -5,7 +5,7 @@
 //! same time.
 //!
 //! For part two the difference of the ASCII values of "M" and "S" is 6. No other combination of
-//! letter has this value, so if both diagonals are a 6 then we have a match.
+//! letters has this value, so if both diagonals are a 6 then we have a match.
 use crate::util::grid::*;
 use crate::util::point::*;
 

src/year2024/day06.rs

@@ -102,7 +102,7 @@ fn is_cycle(
             return true;
         }
 
-        // The tricky part is checking for the new time travelling instigated obstacle.
+        // The tricky part is checking for the newly introduced time-traveling obstacle.
         position = match direction {
             UP => {
                 let next = shortcut.up[position];

src/year2024/day08.rs

@@ -1,6 +1,6 @@
 //! # Resonant Collinearity
 //!
-//! Antennas frequencies are grouped together to reduce the O(n²) pairwise comparisons.
+//! Antenna frequencies are grouped together to reduce the O(n²) pairwise comparisons.
 use crate::util::grid::*;
 use crate::util::hash::*;
 use crate::util::point::*;

src/year2024/day12.rs

@@ -6,8 +6,8 @@
 //! region or out of bounds.
 //!
 //! For part two we count each plot on the edge as either 0, 1 or 2 sides then divide by 2.
-//! An edge plot contributes nothing if it has 2 edge neighbours facing the same way,
-//! one if has a single neighbour and two if it has no neighbours.
+//! An edge plot contributes nothing if it has 2 edge neighbors facing the same way,
+//! one if it has a single neighbor and two if it has no neighbors.
 //!
 //! For example, considering the right edge:
 //!

src/year2024/day15.rs

@@ -115,7 +115,7 @@ fn wide(grid: &mut Grid<u8>, start: &mut Point, direction: Point, todo: &mut Vec
 
     // Clear any items from previous push.
     todo.clear();
-    // Add dummy item to prevent index of out bounds when checking for previously added boxes.
+    // Add dummy item to prevent index out of bounds when checking for previously added boxes.
     todo.push(ORIGIN);
     todo.push(*start);
     let mut index = 1;