Skip to content
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

Merged
merged 1 commit into from
Sep 8, 2020

Conversation

louyuting
Copy link
Collaborator

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

@codecov-commenter
Copy link

codecov-commenter commented Sep 7, 2020

Codecov Report

Merging #231 into master will increase coverage by 0.58%.
The diff coverage is 87.50%.

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
core/flow/slot.go 0.00% <0.00%> (ø)
api/slot_chain.go 70.58% <100.00%> (ø)
core/system/slot.go 54.90% <100.00%> (ø)
core/stat/base_node.go
core/stat/node_storage.go

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8a2f5c4...470b85a. Read the comment docs.

@louyuting louyuting requested a review from sczyh30 September 7, 2020 12:25
@louyuting louyuting added this to the 0.6.1 milestone Sep 7, 2020
@louyuting louyuting added area/document Category issues or PRs related to document. kind/enhancement Category issues or PRs related to enhancement labels Sep 7, 2020
@louyuting louyuting changed the title Refine API and exported structure naming in core pkg Refine API and exported structure naming in core pkg && add doc for api/flow/circuitbreaker Sep 7, 2020
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:
Copy link
Member

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)
Copy link
Member

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
Copy link
Member

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.

@louyuting louyuting changed the title Refine API and exported structure naming in core pkg && add doc for api/flow/circuitbreaker Refine API and exported structure naming in core pkg Sep 8, 2020
@sczyh30 sczyh30 merged commit bd07b4b into alibaba:master Sep 8, 2020
@sczyh30
Copy link
Member

sczyh30 commented Sep 8, 2020

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/document Category issues or PRs related to document. kind/enhancement Category issues or PRs related to enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants