-
Notifications
You must be signed in to change notification settings - Fork 438
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
Refine API and exported structure naming in core pkg #231
Conversation
Codecov Report
@@ Coverage Diff @@
## master #231 +/- ##
==========================================
+ Coverage 42.35% 42.93% +0.58%
==========================================
Files 79 74 -5
Lines 4446 4316 -130
==========================================
- Hits 1883 1853 -30
+ Misses 2329 2230 -99
+ Partials 234 233 -1
Continue to review full report at Codecov.
|
api/doc.go
Outdated
@@ -0,0 +1,51 @@ | |||
// Package api is the topmost API interface package for users using sentinel-golang(aka sentinel) | |||
// | |||
// Users must initialize sentinel before loading sentinel rules. Sentinel support three ways to perform initialization: |
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.
sentinel -> Sentinel (in all cases as a brand)
api/doc.go
Outdated
@@ -0,0 +1,51 @@ | |||
// Package api is the topmost API interface package for users using sentinel-golang(aka sentinel) |
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.
The first sentence should end with .
api/doc.go
Outdated
// log.Fatal(err) | ||
// } | ||
// | ||
// //Load sentinel rules |
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.
The example might be too complicated? Actually we may introduce APIs in this package.
remove unused code
8205e8b
to
470b85a
Compare
Thanks! |
Describe what this PR does / why we need it
Refine API and exported structure naming in core pkg
Does this pull request fix one issue?
Describe how you did it
Describe how to verify it
Special notes for reviews