Skip to content

Fix typos#113

Merged
NickNeck merged 1 commit intohrzndhrn:mainfrom
eksperimental-forks:chore/fix-typos3
Oct 29, 2025
Merged

Fix typos#113
NickNeck merged 1 commit intohrzndhrn:mainfrom
eksperimental-forks:chore/fix-typos3

Conversation

@eksperimental
Copy link
Contributor

@eksperimental eksperimental commented Oct 28, 2025

Changes detected running: typos --format brief --hidden

Typos: https://github.com/crate-ci/typos

Summary by CodeRabbit

  • Documentation

    • Fixed multiple spelling and grammar errors in documentation strings, module descriptions, and changelog entries throughout the codebase.
  • Tests

    • Corrected test descriptions and utility functions with typo fixes for improved clarity and consistency.

Changes detected running: `typos --format brief --hidden`

Typos: https://github.com/crate-ci/typos
@coderabbitai
Copy link

coderabbitai bot commented Oct 28, 2025

📝 Walkthrough

Walkthrough

This PR addresses systematic spelling and typographical errors across the codebase. Changes include correcting misspelled words in documentation strings, module docstrings, comments, and test descriptions (e.g., "fot" → "for", "appliations" → "applications", "handeld" → "handled"). Additionally, the PR renames internal and public functions for correct spelling: formated?formatted? and remove_unecessary_if_unlessremove_unnecessary_if_unless. A variable is also renamed for accuracy: config_timestempconfig_timestamp. No functional logic changes are introduced.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

While the PR spans 18 files, the changes are predominantly homogeneous spelling corrections with straightforward replacements. However, attention is needed for:

  • test/support/recode_case.ex: Public function signature change (formated?formatted?) requires verification that all dependent test files have been updated consistently.
  • lib/recode/task/unnecessary_if_unless.ex: Private function rename (remove_unecessary_if_unlessremove_unnecessary_if_unless) across multiple clauses and call sites should be verified for completeness.
  • test/recode/task/enforce_line_length_test.exs: Multiple assertion updates using the renamed predicate function should be spot-checked to ensure correct test semantics remain intact.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "Fix typos" is directly and fully related to the primary change in the changeset. The raw summary shows that all modifications across 19 files—including corrections like "fot"→"for", "Exapnds"→"Expands", "handeld"→"handled", and variable renaming from "formated?"→"formatted?"—are typo fixes and spelling corrections. The PR objectives explicitly confirm this is a typo-fixing effort using the typos tool. The title is concise, readable, and specific enough that a teammate scanning the history immediately understands the primary change.
Docstring Coverage ✅ Passed Docstring coverage is 80.00% which is sufficient. The required threshold is 80.00%.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 01319c1 and 6f37f3a.

📒 Files selected for processing (18)
  • CHANGELOG.md (3 hunks)
  • README.md (1 hunks)
  • lib/mix/tasks/recode.help.ex (1 hunks)
  • lib/mix/tasks/recode.update.config.ex (1 hunks)
  • lib/recode/ast.ex (1 hunks)
  • lib/recode/config.ex (1 hunks)
  • lib/recode/runner/impl.ex (2 hunks)
  • lib/recode/task/alias_expansion.ex (1 hunks)
  • lib/recode/task/format.ex (1 hunks)
  • lib/recode/task/tag_fixme.ex (1 hunks)
  • lib/recode/task/tag_todo.ex (1 hunks)
  • lib/recode/task/unnecessary_if_unless.ex (4 hunks)
  • test/recode/context_test.exs (2 hunks)
  • test/recode/task/enforce_line_length_test.exs (15 hunks)
  • test/recode/task/filter_count_test.exs (2 hunks)
  • test/recode/task/moduledoc_test.exs (1 hunks)
  • test/recode/task/nesting_test.exs (6 hunks)
  • test/support/recode_case.ex (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2024-11-15T15:46:36.333Z
Learnt from: NickNeck
PR: hrzndhrn/recode#97
File: mix.exs:69-69
Timestamp: 2024-11-15T15:46:36.333Z
Learning: When a module is renamed, references to the old module name in tests like `test/mix/tasks/recode.update.config_test.exs` may be intentionally kept to simulate updating old configurations and should not be flagged.

Applied to files:

  • lib/mix/tasks/recode.update.config.ex
  • test/recode/task/moduledoc_test.exs
🧬 Code graph analysis (3)
test/recode/task/enforce_line_length_test.exs (1)
test/support/recode_case.ex (1)
  • formatted? (150-152)
lib/recode/runner/impl.ex (2)
lib/recode/timestamp.ex (1)
  • for_file (10-15)
lib/recode/manifest.ex (1)
  • read (37-57)
lib/recode/task/unnecessary_if_unless.ex (1)
lib/recode/task.ex (2)
  • update_source (141-156)
  • update_source (186-188)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Test on Ubuntu (Elixir 1.19.0, OTP 28.1)
🔇 Additional comments (23)
lib/recode/task/tag_fixme.ex (1)

7-7: LGTM! Typo corrected.

The spelling correction from "handeld" to "handled" improves documentation quality.

lib/mix/tasks/recode.help.ex (1)

5-5: LGTM! Typo corrected.

The spelling correction from "availbale" to "available" improves documentation quality.

lib/recode/config.ex (1)

170-170: LGTM! Typo corrected.

The spelling correction from "cofiguration" to "configuration" improves documentation quality.

lib/mix/tasks/recode.update.config.ex (1)

7-10: LGTM! Typos corrected.

The spelling corrections ("exsiting" → "existing" and "acutal" → "actual") improve documentation quality.

lib/recode/task/tag_todo.ex (1)

7-7: LGTM! Typo corrected.

The spelling correction from "handeld" to "handled" improves documentation quality.

lib/recode/task/alias_expansion.ex (1)

2-2: LGTM! Typo corrected.

The spelling correction from "Exapnds" to "Expands" improves documentation quality.

lib/recode/task/format.ex (1)

11-11: LGTM! Typo corrected.

The spelling correction from "debuging" to "debugging" improves comment quality.

test/recode/task/moduledoc_test.exs (1)

7-7: LGTM! Typo corrected.

The spelling correction from "availabel" to "available" improves test description quality.

README.md (1)

22-22: LGTM! Typo corrected.

The spelling of "Expands" is now correct in the AliasExpansion task description.

lib/recode/ast.ex (1)

3-7: LGTM! Grammar corrected.

The module documentation now uses correct grammar with "get information" instead of "get informations".

lib/recode/runner/impl.ex (2)

197-197: LGTM! Comment typo corrected.

The comment now correctly spells "directly".


249-252: LGTM! Variable name corrected.

The variable has been renamed from config_timestemp to config_timestamp, correcting the spelling. All usages are updated consistently in the guard clause.

CHANGELOG.md (3)

35-35: LGTM! Typo corrected.

"for" is now correctly spelled in the changelog entry.


53-53: LGTM! Typo corrected.

"applications" is now correctly spelled in the changelog entry.


138-138: LGTM! Typo corrected.

"Task" is now correctly spelled in the changelog entry.

lib/recode/task/unnecessary_if_unless.ex (2)

5-5: LGTM! Typos corrected in module documentation.

The module documentation now correctly spells "Redundant" and "needlessly".


32-75: LGTM! Function renamed for correct spelling.

The private function has been consistently renamed from remove_unecessary_if_unless to remove_unnecessary_if_unless across all clauses (lines 38, 55, 75) and the call site (line 32).

test/recode/task/filter_count_test.exs (2)

201-201: LGTM! Typo corrected in test description.

The test description now correctly spells "pipeline".


364-364: LGTM! Typo corrected in test description.

The test description now correctly spells "pipeline".

test/recode/task/nesting_test.exs (1)

58-176: LGTM! Typos corrected in test descriptions.

The test descriptions now correctly spell "triggers" (lines 58, 81, 100, 124, 148, 176) and "greater" (line 124).

test/recode/context_test.exs (1)

198-219: LGTM! Typos corrected in test descriptions.

The test descriptions now correctly spell "traverses" (lines 198, 219).

test/support/recode_case.ex (1)

150-150: LGTM! Typo corrected.

The function name has been correctly updated from formated? to formatted?.

test/recode/task/enforce_line_length_test.exs (1)

21-21: LGTM! All call sites updated consistently.

All assertions have been correctly updated to use formatted? instead of formated?, matching the function rename in test/support/recode_case.ex.

Also applies to: 65-65, 83-83, 104-104, 130-130, 151-151, 179-179, 214-214, 250-250, 268-268, 301-301, 339-339, 370-370, 403-403, 439-439


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@NickNeck
Copy link
Member

Thank you very much

@NickNeck NickNeck merged commit d239a9a into hrzndhrn:main Oct 29, 2025
9 checks passed
@eksperimental
Copy link
Contributor Author

Thank you very much

You are welcome @NickNeck, I really like your app.

@eksperimental eksperimental deleted the chore/fix-typos3 branch October 29, 2025 07:26
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.

2 participants