Update adding-new-translation-messages-or-changing-the-default-ones.md

[Popovkov57]

Update of function naming. Close #49

Summary by CodeRabbit

• Documentation
  • Updated instructions and examples to use the correct functions for handling server-defined translation keys, improving clarity on internationalization practices.

[coderabbitai]

Walkthrough

The documentation was updated to replace references to msg() and advancedMsg() with msgStr() and advancedMsgStr() respectively, specifically for translation keys defined only on the server side. Explanations and examples were revised to clarify the correct usage of these functions in handling server-defined i18n message keys.

Changes

Cohort / File(s)	Change Summary
i18n Documentation Update features/i18n/adding-new-translation-messages-or-changing-the-default-ones.md	Updated code examples and explanations to use msgStr() and advancedMsgStr() for server-only translation keys, replacing previous references to msg() and advancedMsg(). Clarified function equivalence and TypeScript behavior.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐇
In docs we hop, with care we tread,
Swapping msg for msgStr instead.
Advanced calls now clearly shown,
TypeScript errors overthrown!
With every string, translations sing—
The rabbit’s guide to i18n’s spring.
🌸

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

features/i18n/adding-new-translation-messages-or-changing-the-default-ones.md (2)

117-120: Consider adding the recommended advancedMsgStr() call right after the msgStr() example.

The snippet correctly demonstrates that msgStr("profile.attributes.favourite_pet") compiles but produces a TS error. However, the immediate follow-up example using advancedMsgStr() is buried in the prose below. Adding it beside the msgStr() call would make the contrast crystal-clear for readers skimming the doc.

 msgStr("profile.attributes.favourite_pet");
+
+// type-safe alternative
+advancedMsgStr("profile.attributes.favourite_pet");

---

122-123: Minor grammar tweak — “some place” → “some places”.

-This is why you'll see in some place in the code the usage of `advancedMsgStr(attribute.displayName)`,
+This is why you'll see in some places in the code the usage of `advancedMsgStr(attribute.displayName)`,

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b7deb83 and 19a6965.

📒 Files selected for processing (1)

• features/i18n/adding-new-translation-messages-or-changing-the-default-ones.md (1 hunks)