gpi-enable-wpml-for-custom-messages.php: Added usage instructions.
#1064
Conversation
WalkthroughThe changes add an instructional comment block at the beginning of the file Changes
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
gp-inventory/gpi-enable-wpml-for-custom-messages.php (1)
5-13: Documentation Enhancement: Clear and Detailed Usage InstructionsThe newly added instructional comment block effectively guides users through the necessary steps for integrating WPML with custom inventory messages. It clearly outlines:
- Installation of the snippet.
- How to trigger custom message registration by viewing the form.
- Navigating to WPML > String Translation in wp-admin to perform translations.
To improve clarity further, consider explicitly mentioning that WPML must be pre-installed and active for these instructions to be applicable. This minor enhancement could help prevent confusion for users who might assume the snippet handles WPML integration entirely.
For example, you could update the third step as follows:
- * 3. Navigate to WPML > String Translation in wp-admin, where the strings will be available to translate. + * 3. Ensure WPML is installed and activated. Then, navigate to WPML > String Translation in wp-admin, where the strings will be available to translate.
Context
⛑️ Ticket(s): https://secure.helpscout.net/conversation/2892903236/81524?viewId=14964
Summary
Added usage instructions as it wasn't clear how to get the strings into WPML once the snippet was installed.