Skip to content

fix: correct spelling in comments#1802

Open
HusseinAdeiza wants to merge 1 commit into
scroll-tech:developfrom
HusseinAdeiza:fix/comment-typos
Open

fix: correct spelling in comments#1802
HusseinAdeiza wants to merge 1 commit into
scroll-tech:developfrom
HusseinAdeiza:fix/comment-typos

Conversation

@HusseinAdeiza
Copy link
Copy Markdown

@HusseinAdeiza HusseinAdeiza commented May 23, 2026

Description

Fixed spelling errors in code comments.

⚠️ Note: Comment-only changes. No functional code modified.

Changes

  • Fix 'cant' → 'can't'
  • Fix hyphenation in technical term

Files Modified

  • common/database/db.go
  • crates/libzkp/src/tasks/batch/utils.rs

Impact

  • Comment clarity improvement only
  • No functional changes to Scroll L2 logic

Summary by CodeRabbit

  • Documentation
    • Updated internal documentation comments for improved clarity and consistency.

Review Change Stack

- Fix 'cant' → 'can't'
- Fix hyphenation in technical term

⚠️ Note: Comment-only changes. No functional code modified.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 23, 2026

📝 Walkthrough

Walkthrough

This PR updates two isolated comment strings across different modules. The database initialization comment clarifies MySQL DSN and Postgres timezone behavior; the cryptographic utility doc comment refines wording. No functional logic or exported API signatures are altered.

Changes

Documentation Clarifications

Layer / File(s) Summary
Comment updates and documentation improvements
common/database/db.go, crates/libzkp/src/tasks/batch/utils.rs
Comment in InitDB clarified with corrected wording and additional detail about MySQL loc=Local behavior and Postgres timezone handling; doc comment line in point_eval::to_blob reformatted for improved phrasing.

🎯 1 (Trivial) | ⏱️ ~3 minutes

Hopping through with careful words so bright, 🐰
Comments polished, clarity's my delight,
MySQL locals and Postgres paths aligned,
Documentation whispers, all refined,
Small edits bloom where great code finds its might!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'fix: correct spelling in comments' accurately summarizes the main change—correcting spelling errors in code comments across two files.
Description check ✅ Passed The PR description is well-structured with clear sections (Description, Changes, Files Modified, Impact) and directly addresses what was changed, why, and the impact. It aligns with the repository template's Purpose or design rationale section.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
common/database/db.go (1)

60-61: ⚡ Quick win

Narrow this comment to Postgres behavior only.

This function initializes Postgres only, so the MySQL DSN example is distracting and can mislead future readers about supported configuration paths here. Consider rewriting the comment to describe only why NowFunc forces UTC for Postgres inserts.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@common/database/db.go` around lines 60 - 61, Replace the current multi-DB
comment with a focused Postgres-only note: remove the MySQL DSN example and
state that this initialization is Postgres-specific and that setting
gorm.Config.NowFunc to time.Now().UTC forces inserts/updates to use UTC
(ensuring consistent timezone handling for Postgres connections). Update the
comment that sits above the code that sets gorm.Config.NowFunc (the Postgres
initialization function) to reflect this concise explanation.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@common/database/db.go`:
- Around line 60-61: Replace the current multi-DB comment with a focused
Postgres-only note: remove the MySQL DSN example and state that this
initialization is Postgres-specific and that setting gorm.Config.NowFunc to
time.Now().UTC forces inserts/updates to use UTC (ensuring consistent timezone
handling for Postgres connections). Update the comment that sits above the code
that sets gorm.Config.NowFunc (the Postgres initialization function) to reflect
this concise explanation.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b48ea92c-2b14-4def-9bf6-4c9ba10db689

📥 Commits

Reviewing files that changed from the base of the PR and between 71f7160 and 0e9a4a6.

📒 Files selected for processing (2)
  • common/database/db.go
  • crates/libzkp/src/tasks/batch/utils.rs

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