gp-inventory/gpi-inventory-shortcode.php: Added deprecation reason to snippet and removed snippet code.
#1098
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe entire implementation of the Changes
Possibly related PRs
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
✨ 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:
SupportNeed 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)
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-inventory-shortcode.php (1)
3-5: Suggest enriching deprecation notice with version tag and documentation linkFor better discoverability and adherence to PHPDoc conventions, you could add a
@deprecatedtag with the version and include a link to the plugin docs. For example:* WARNING! THIS SNIPPET IS DEPRECATED. 🚧 - * This snippet's functionality has been moved to the GP Inventory plugin in version 1.0. + * @deprecated 1.0 Use GP Inventory plugin for this feature. + * @see https://gravitywiz.com/documentation/gp-inventory/shortcodes/#inventory
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
gp-inventory/gpi-inventory-shortcode.php(1 hunks)
🔇 Additional comments (1)
gp-inventory/gpi-inventory-shortcode.php (1)
4-4: Approve deprecation notice additionThe deprecation reason clearly indicates that the snippet’s functionality has been migrated to the GP Inventory plugin in version 1.0, which improves clarity for users.
| * | ||
| * @todo | ||
| * - Add support for excluding field parameter and showing a consolidated list of all inventories. | ||
| * This snippet's functionality has been moved to the GP Inventory plugin in version 1.0. |
There was a problem hiding this comment.
| * This snippet's functionality has been moved to the GP Inventory plugin in version 1.0. | |
| * This snippet's functionality has been moved to [GP Inventory][1] in version 1.0. | |
| * | |
| * [1] https://gravitywiz.com/documentation/gravity-forms-inventory/ |
Felt like a link would be nice to redirect them more efficiently. No strong feelings.
There was a problem hiding this comment.
I dig it! And Code Rabbit agrees 😆
…to snippet and removed snippet code.
Context
The shortcode functionality has been moved into GPI 1.0.
Summary
Removes snippet code and adds deprecation reason.