fix: Socket Badge link in README_custom_badges.mustache#680
fix: Socket Badge link in README_custom_badges.mustache#680SoulPancake merged 1 commit intoopenfga:mainfrom
Conversation
WalkthroughUpdated the Socket Badge URL in the Python README template to use a version-specific page instead of a general package page. This single-line change makes the badge link more precisely point to version-specific badge information. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
There was a problem hiding this comment.
Pull request overview
This PR fixes a syntax error in the Python SDK template where the Socket Badge markdown link was missing a closing parenthesis. The fix ensures the badge will render correctly in the generated Python SDK README file.
Changes:
- Fixed missing closing parenthesis in Socket Badge markdown link syntax
There was a problem hiding this comment.
🧹 Nitpick comments (2)
config/clients/python/template/README_custom_badges.mustache (2)
2-2: Optional: make the badge click-through URL version-specific as well.The image URL includes
{{packageVersion}}(version-scoped badge), but the link target is the generic package page. If socket.dev supports version-specific pages at the same path pattern, the link could mirror the image URL for a consistent user experience.♻️ Suggested change
-[](https://socket.dev/pypi/package/openfga-sdk) +[](https://socket.dev/pypi/package/openfga-sdk/{{packageVersion}})🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@config/clients/python/template/README_custom_badges.mustache` at line 2, Update the badge link to be version-specific to match the image URL: change the anchor href that currently points to the generic package page to use the same version-scoped path as the image URL by including {{packageVersion}} (the same token used in the image URL in the README_custom_badges.mustache template) so the clickable badge navigates to the specific version page on socket.dev.
2-2: Nitpick: use{{packageName}}instead of hardcodedopenfga-sdk.Line 1 uses
{{packageName}}for the PyPI badge; both socket.dev URLs on line 2 hardcodeopenfga-sdk. Using the template variable keeps the file consistent and avoids a silent mismatch if the package name ever changes.♻️ Suggested change
-[](https://socket.dev/pypi/package/openfga-sdk) +[](https://socket.dev/pypi/package/{{packageName}})🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@config/clients/python/template/README_custom_badges.mustache` at line 2, The socket.dev badge lines in README_custom_badges.mustache hardcode "openfga-sdk"; update both occurrences (the image URL and the link URL) to use the template variable {{packageName}} instead so they match the existing {{packageName}} usage for PyPI and avoid future mismatches.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@config/clients/python/template/README_custom_badges.mustache`:
- Line 2: Update the badge link to be version-specific to match the image URL:
change the anchor href that currently points to the generic package page to use
the same version-scoped path as the image URL by including {{packageVersion}}
(the same token used in the image URL in the README_custom_badges.mustache
template) so the clickable badge navigates to the specific version page on
socket.dev.
- Line 2: The socket.dev badge lines in README_custom_badges.mustache hardcode
"openfga-sdk"; update both occurrences (the image URL and the link URL) to use
the template variable {{packageName}} instead so they match the existing
{{packageName}} usage for PyPI and avoid future mismatches.
Description
The Socket Badge isn't displayed correctly in the README because of a missing parenthesis. This PR aims to fix it.
References
Corresponding PR in the python-sdk repo: !257
Review Checklist
mainSummary by CodeRabbit
Release Notes