Skip to content

Commit 1e5e2d9

Browse files
authored
docs: minor improvement for docs (#651)
Signed-off-by: huyejia <[email protected]>
1 parent da47afa commit 1e5e2d9

File tree

3 files changed

+6
-6
lines changed

3 files changed

+6
-6
lines changed

internal/bft/controller.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ func (c *Controller) HandleRequest(sender uint64, req []byte) {
254254
c.addRequest(reqInfo, req)
255255
}
256256

257-
// SubmitRequest Submits a request to go through consensus.
257+
// SubmitRequest submits a request to go through consensus.
258258
func (c *Controller) SubmitRequest(request []byte) error {
259259
info := c.RequestInspector.RequestID(request)
260260
return c.addRequest(info, request)

internal/bft/requestpool.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const (
2323
defaultRequestTimeout = 10 * time.Second // for unit tests only
2424
defaultMaxBytes = 100 * 1024 // default max request size would be of size 100Kb
2525
defaultSizeOfDelElements = 1000 // default size slice of delete elements
26-
defaultEraseTimeout = 5 * time.Second // for cicle erase silice of delete elements
26+
defaultEraseTimeout = 5 * time.Second // for cycle erase silice of delete elements
2727
)
2828

2929
var (
@@ -46,9 +46,9 @@ type RequestTimeoutHandler interface {
4646
OnAutoRemoveTimeout(requestInfo types.RequestInfo)
4747
}
4848

49-
// Pool implements requests pool, maintains pool of given size provided during
50-
// construction. In case there are more incoming request than given size it will
51-
// block during submit until there will be place to submit new ones.
49+
// Pool implements a requests pool, maintaining a pool of a given size provided during
50+
// construction. If there are more incoming requests than the given size, it will
51+
// block during submission until there is space to submit new ones.
5252
type Pool struct {
5353
logger api.Logger
5454
metrics *api.MetricsRequestPool

internal/bft/viewchanger.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ type change struct {
4848
stopView bool
4949
}
5050

51-
// ViewChanger is responsible for running the view change protocol
51+
// ViewChanger is responsible for running the view change protocol.
5252
type ViewChanger struct {
5353
// Configuration
5454
SelfID uint64

0 commit comments

Comments
 (0)