docs: expand README localization section, add v1.0.0 to CHANGELOG, up…#26
docs: expand README localization section, add v1.0.0 to CHANGELOG, up…#26rolling-codes merged 1 commit intomainfrom
Conversation
…date release notes
Reviewer's GuideExpands the README with a practical localization example and records the 1.0.0 stable release details in the changelog, emphasizing localization features and stability notes. Flow diagram for localization fallback resolutionflowchart TD
A[user_locale] -->|has_translation| R["return translated string"]
A -->|missing_or_unset| B[guild_locale]
B -->|has_translation| R
B -->|missing_or_unset| C[default_locale]
C -->|has_translation| R
C -->|missing_or_unset| D[english_locale]
D -->|has_translation| R
D -->|missing_or_unset| E["return key or safe fallback"]
subgraph LocalizationLookup
A
B
C
D
end
F[ctx_t_call] --> A
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughSummary by CodeRabbit
WalkthroughAdded version 1.0.0 changelog entry documenting the completion of localization system features, including Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Poem
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- The first localization example block is labeled as
pythonbut contains JSON; consider switching that block tojsonfor more accurate syntax highlighting and to avoid confusion. - In the changelog note 'No breaking changes from pre-1.0 versions', it might be clearer to explicitly name the previous version range (e.g.
0.x) so readers can quickly see what compatibility guarantees apply.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The first localization example block is labeled as `python` but contains JSON; consider switching that block to `json` for more accurate syntax highlighting and to avoid confusion.
- In the changelog note 'No breaking changes from pre-1.0 versions', it might be clearer to explicitly name the previous version range (e.g. `0.x`) so readers can quickly see what compatibility guarantees apply.
## Individual Comments
### Comment 1
<location path="README.md" line_range="61" />
<code_context>
+bot = Bot(localization=locales, default_locale="en")
+```
+
+Translations fallback gracefully: user locale → guild locale → default locale → English. See [`docs/localization.md`](docs/localization.md) for the full guide.
+
## Why this exists
</code_context>
<issue_to_address>
**issue (typo):** Use "fall back" (two words) instead of "fallback" when used as a verb.
Here it’s used as a verb, so the correct form is "fall back" (two words).
```suggestion
Translations fall back gracefully: user locale → guild locale → default locale → English. See [`docs/localization.md`](docs/localization.md) for the full guide.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
;;][ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
🤖 Augment PR SummarySummary: Updates EasyCord’s documentation to reflect the new localization feature set and the v1.0.0 release. Changes:
Notes: These changes are documentation-only but affect the copy/paste correctness of the onboarding examples. 🤖 Was this summary useful? React with 👍 or 👎 |
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
| Build bots that speak your server's language: | ||
|
|
||
| ```python | ||
| # Define translations in a locale file (en.json) |
There was a problem hiding this comment.
README.md:34 — This fenced block is tagged as python but contains JSON as well, which makes syntax highlighting/copy-paste misleading for readers.
Severity: low
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
|
|
||
| ```python | ||
| # Define translations in a locale file (en.json) | ||
| { |
There was a problem hiding this comment.
README.md:35 — LocalizationManager stores catalogs as a flat key -> string mapping (e.g., "commands.ping.response"), so a nested JSON object like this won’t be resolved by ctx.t("commands.ping.response").
Severity: high
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| from easycord import Bot, LocalizationManager | ||
|
|
||
| locales = LocalizationManager() | ||
| locales.register("en", "locales/en.json") |
There was a problem hiding this comment.
README.md:55 — LocalizationManager.register(locale, translations) expects a mapping of translation keys to strings; passing a file path string here will fail at runtime (it calls .items() on the argument).
Severity: high
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| locales.register("en", "locales/en.json") | ||
| locales.register("es", "locales/es.json") | ||
|
|
||
| bot = Bot(localization=locales, default_locale="en") |
There was a problem hiding this comment.
README.md:58 — When localization= is provided, Bot does not apply default_locale (it’s only used when translations are passed), so this example likely won’t set the manager’s fallback locale as intended.
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
| @@ -1,5 +1,23 @@ | |||
| # Changelog | |||
|
|
|||
| ## [1.0.0] — 2026-04-24 | |||
There was a problem hiding this comment.
CHANGELOG.md:3 — Adding a 1.0.0 section above an existing 2.8 entry makes the changelog’s version progression ambiguous (since 2.8 sorts higher than 1.0.0 in semver).
Severity: medium
🤖 Was this useful? React with 👍 or 👎, or 🚀 if it prevented an incident/outage.
2 participants
…date release notes
Summary by Sourcery
Document localization usage and record the 1.0.0 stable release in project docs.
Documentation: