Skip to content

Conversation

c-gamble
Copy link
Contributor

Description of changes

Fix existing typos and add a PR check to check for typos.

Test plan

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link
Contributor

propel-code-bot bot commented Sep 19, 2025

Fix Typos Across Codebase and Add Automated Typo Check

This PR corrects numerous typographical, spelling, and grammatical errors throughout the codebase, including code comments, documentation, markdown, docstrings, test code, and user-facing messages. Additionally, the PR introduces an automated typo-checking workflow for pull requests, leveraging the 'typos' tool and a custom typos.toml configuration to systematically block future typos. The changes aim to improve code readability, documentation clarity, and overall project professionalism without altering functionality.

Key Changes

• Fixed typos and grammatical errors in code comments, method and variable names, error messages, and inline documentation across Python, Rust, Go, markdown, shell scripts, and configuration files.
• Corrected spelling and grammar in user-facing and contributor-facing documentation (Markdown, Jupyter notebooks, .txt, .md, etc).
• Standardized terminology and wording for consistency (e.g., variable, method, and comment spelling).
• Added a new typo-check job to the GitHub Actions PR workflow using 'typos', with a customized configuration file typos.toml specifying project-specific whitelist exceptions and ignore rules.
• Updated test assertions and docstrings for spelling and accuracy in both English and code APIs.
• Adjusted code and documentation to reflect corrected spellings and grammar in variable names, function comments, docstrings, and external-facing text.
• Fixed small issues such as duplicate words, missing articles, missing or extra letters, and other minor syntactic problems.

Affected Areas

• All major language codebases (Rust, Python, Go, TypeScript/JavaScript)
• Documentation (Markdown, TXT, Jupyter Notebooks, READMEs, etc.)
• GitHub workflow and CI configuration
• Code comments, docstrings, test files, variable/function names (where appropriate)
• CLI and SDK user-facing messages

This summary was automatically generated by @propel-code-bot

on the manifest.

## Object Store Layout

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[Documentation]

Fix grammar: "will overwritten" should be "will be overwritten"

Context for Agents
[**Documentation**]

Fix grammar: "will overwritten" should be "will be overwritten"

File: rust/wal3/README.md
Line: 150

@blacksmith-sh blacksmith-sh bot deleted a comment from c-gamble Sep 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant