Skip to content

chore: translate the leftover Japanese JSDoc comments - #369

Merged
RAIT-09 merged 1 commit into
devfrom
chore/jsdoc-english-leftovers
Jul 17, 2026
Merged

chore: translate the leftover Japanese JSDoc comments#369
RAIT-09 merged 1 commit into
devfrom
chore/jsdoc-english-leftovers

Conversation

@RAIT-09

@RAIT-09 RAIT-09 commented Jul 17, 2026

Copy link
Copy Markdown
Owner

Description

Two JSDoc lines in preset-agents.ts (legacySettingsKey / legacyCommandPathKey) still carried a Japanese fragment ("data.json 旧形式 …") from the registry design sketch — the translation of the leading words was missed when the registry landed in #348. Both now read Legacy data.json ….

A full sweep for Japanese characters (hiragana, katakana, CJK, full-width punctuation) across src/, test/, styles.css, config files, docs/ sources, and .github/ confirmed these two lines were the only remaining occurrences — the codebase is now English-only (README.ja.md is intentionally Japanese and out of scope).

Related issue

None.

Type of change

  • Bug fix
  • New feature
  • Documentation
  • Refactor
  • Other (comment-only cleanup)

Checklist

  • npm run lint passes ("Use sentence case for UI text" warnings are acceptable for brand names)
  • npm run build passes
  • Tested in Obsidian (no runtime change — comment-only)
  • Existing functionality still works
  • Documentation updated if needed (N/A)

Testing environment

  • Agent: N/A (comment-only change; build/lint/tests green)
  • OS: macOS

Screenshots

N/A

Summary by CodeRabbit

  • Documentation
    • Clarified internal documentation for legacy configuration keys.
    • Improved the formatting and relationship between related configuration settings.

@RAIT-09 RAIT-09 self-assigned this Jul 17, 2026
@coderabbitai

coderabbitai Bot commented Jul 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 5bca23c6-5e95-49ea-92cf-88d28c6cc083

📥 Commits

Reviewing files that changed from the base of the PR and between edc8195 and 735cbc3.

📒 Files selected for processing (1)
  • src/services/preset-agents.ts

📝 Walkthrough

Walkthrough

The change revises JSDoc for legacy preset-agent keys in PresetAgentDefinition. Runtime logic, types, and exported API signatures remain unchanged.

Changes

Preset agent documentation

Layer / File(s) Summary
Legacy key JSDoc
src/services/preset-agents.ts
Rewords the legacySettingsKey documentation and reformats the adjacent legacyCommandPathKey comment without changing declarations.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

Poem

A bunny hops through comments bright,
Legacy keys now read just right.
No code was changed, no types were stirred,
Just clearer meaning in every word.
🐇✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: translating leftover Japanese JSDoc comments to English.
Description check ✅ Passed The description matches the template and fills the required sections with enough detail for this comment-only cleanup.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/jsdoc-english-leftovers

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.

@RAIT-09
RAIT-09 merged commit 2484b31 into dev Jul 17, 2026
2 checks passed
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