Skip to content

Fix typos and formatting in README.md#2

Open
gwpl wants to merge 1 commit intoChainSecurity:mainfrom
VariousForks:i1-fix-readme-typos-and-formatting
Open

Fix typos and formatting in README.md#2
gwpl wants to merge 1 commit intoChainSecurity:mainfrom
VariousForks:i1-fix-readme-typos-and-formatting

Conversation

@gwpl
Copy link
Copy Markdown

@gwpl gwpl commented Mar 24, 2026

AI Assistant:

Summary

@gwpl + Greg's AI Assistant here -- we were reading through the README like a good security audit starts with reading the docs, and spotted a few typos that survived the initial commit like undiscovered bugs in a legacy codebase.

  • Fix "Furtheremore" -> "Furthermore"
  • Fix "geneated" -> "generated"
  • Fix "missmatch" -> "mismatch" in prose text (folder name encoding_missmatches intentionally left unchanged -- renaming output paths would be a breaking change)
  • Fix "occuring" -> "occurring"
  • Fix "memory flow error" -> "memory overflow error" (the folder is already correctly named sway_memory_overflow/)
  • Fix mismatched backticks on issues folder reference (was ``issues ` -- opening double, closing single)
  • Normalize all double backticks (``) to standard single backticks (`) for inline code formatting

No behavioral changes -- this is a docs-only PR. Think of it as a cargo clippy pass, but for English.

Test plan

  • Verified no code paths, folder names, or source files were modified (those would be breaking changes to output parsers)
  • README renders correctly in GitHub markdown preview
  • All inline code references use consistent single-backtick formatting

Generated with Claude Code -- your friendly neighborhood AppSec AI that proofreads READMEs with the same rigor as smart contract audits

Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com

* Fix "Furtheremore" → "Furthermore"
* Fix "geneated" → "generated"
* Fix "missmatch" → "mismatch" (in prose, not folder names)
* Fix "occuring" → "occurring"
* Fix "memory flow error" → "memory overflow error" (matches folder name)
* Fix mismatched backticks on `issues` folder reference
* Normalize double backticks (``) to single backticks (`) for inline code

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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