-
Notifications
You must be signed in to change notification settings - Fork 30
fix(docs): fix build failure of the CWT example #214
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: Shiwei Zhang <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #214 +/- ##
==========================================
- Coverage 92.35% 91.27% -1.09%
==========================================
Files 12 12
Lines 1622 2005 +383
==========================================
+ Hits 1498 1830 +332
- Misses 68 119 +51
Partials 56 56 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request addresses build failures in the CWT example by modifying the example function's name.
- Renamed the example function from ExampleCWTMessage to Example_cWTMessage to resolve build issues.
Comments suppressed due to low confidence (1)
cwt_test.go:13
- [nitpick] Consider revisiting the naming convention for Go example functions. The standard approach typically uses CamelCase (e.g., ExampleCWTMessage), so if the change to Example_cWTMessage is required for the build, adding a clarifying comment might help future maintainers.
func Example_cWTMessage() {
qmuntal
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if it is renamed as ExampleCWTClaims? This way the example will be attached to the CWTClaims struct, which is probably more aligned with the original intention.
Signed-off-by: Shiwei Zhang <[email protected]>
|
@qmuntal That also works. Updated to |


Fix #213 for the build failure of the CWT example.