chore: fix typo and syntax error

Author: xiaost

CONTRIBUTING.md

@@ -14,7 +14,7 @@ We use [git-flow](https://nvie.com/posts/a-successful-git-branching-model/) as o
 We are using [Github Issues](https://github.com/cloudwego/netpoll/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
 
 ### 2. Reporting New Issues
-Providing a reduced test code is a recommended way for reporting issues. Then can placed in:
+Providing a reduced test code is a recommended way for reporting issues. Then can be placed in:
 - Just in issues
 - [Golang Playground](https://play.golang.org/)
 
@@ -45,9 +45,9 @@ Before you submit your Pull Request (PR) consider the following guidelines:
 
 ## Contribution Prerequisites
 - Our development environment keeps up with [Go Official](https://golang.org/project/).
-- You need fully checking with lint tools before submit your pull request. [gofmt](https://golang.org/pkg/cmd/gofmt/) and [golangci-lint](https://github.com/golangci/golangci-lint)
+- You need to fully check with lint tools before submitting your pull request. [gofmt](https://golang.org/pkg/cmd/gofmt/) and [golangci-lint](https://github.com/golangci/golangci-lint)
 - You are familiar with [Github](https://github.com)
-- Maybe you need familiar with [Actions](https://github.com/features/actions)(our default workflow tool).
+- Maybe you need to be familiar with [Actions](https://github.com/features/actions)(our default workflow tool).
 
 ## Code Style Guides
 - [Effective Go](https://golang.org/doc/effective_go)

_typos.toml

@@ -6,5 +6,4 @@ extend-exclude = ["go.mod", "go.sum"]
 [default.extend-identifiers]
 # *sigh* this just isn't worth the cost of fixing
 nd = "nd"
-paniced = "paniced"
 write_datas = "write_datas"

connection_errors.go

@@ -24,7 +24,7 @@ import (
 const (
 	// The connection closed when in use.
 	ErrConnClosed = syscall.Errno(0x101)
-	// Read I/O buffer timeout, calling by Connection.Reader
+	// Read I/O buffer timeout, called by Connection.Reader
 	ErrReadTimeout = syscall.Errno(0x102)
 	// Dial timeout
 	ErrDialTimeout = syscall.Errno(0x103)

connection_impl.go

@@ -32,7 +32,7 @@ const (
 	connStateDisconnected = 2
 )
 
-// connection is the implement of Connection
+// connection is the implementation of Connection
 type connection struct {
 	netFD
 	onEvent

connection_lock.go

@@ -53,7 +53,7 @@ const (
 )
 
 type locker struct {
-	// keychain use for lock/unlock/stop operation by who.
+	// keychain used for lock/unlock/stop operation by who.
 	// 0 means unlock, 1 means locked, 2 means stop.
 	keychain [total]int32
 }

connection_onevent.go

@@ -231,7 +231,7 @@ func (c *connection) onProcess(onConnect OnConnect, onRequest OnRequest) (proces
 		if closedBy != none {
 			//  if closed by user when processing, it "may" needs detach
 			needDetach := closedBy == user
-			// Here is a conor case that operator will be detached twice:
+			// Here is a corner case that operator will be detached twice:
 			//   If server closed the connection(client OnHup will detach op first and closeBy=poller),
 			//   and then client's OnRequest function also closed the connection(closeBy=user).
 			// But operator already prevent that detach twice will not cause any problem
@@ -240,7 +240,7 @@ func (c *connection) onProcess(onConnect OnConnect, onRequest OnRequest) (proces
 			return
 		}
 		c.unlock(processing)
-		// Note: Poller's closeCallback call will try to get processing lock failed but here already neer to unlock processing.
+		// Note: Poller's closeCallback call will try to get processing lock failed but here already near to unlock processing.
 		//       So here we need to check connection state again, to avoid connection leak
 		// double check close state
 		if c.status(closing) != 0 && c.lock(processing) {

docs/guide/guide_cn.md

@@ -190,7 +190,7 @@ func main() {
 	var conn netpoll.Connection
 	var reader, writer = conn.Reader(), conn.Writer()
 
-	// reading 
+	// reading
 	buf, _ := reader.Next(n)
 	... parse the read data ...
 	reader.Release()
@@ -199,7 +199,7 @@ func main() {
 	var write_data []byte
 	... make the write data ...
 	alloc, _ := writer.Malloc(len(write_data))
-	copy(alloc, write_data) // write data 
+	copy(alloc, write_data) // write data
 	writer.Flush()
 }
 ```
@@ -430,7 +430,7 @@ func main() {
 
 	// or
 
-	// 2. setting with Option 
+	// 2. setting with Option
 	netpoll.NewEventLoop(handler, netpoll.WithReadTimeout(timeout))
 	...
 }
@@ -455,7 +455,7 @@ func main() {
 
 	// or
 
-	// 2. setting with Option 
+	// 2. setting with Option
 	netpoll.NewEventLoop(handler, netpoll.WithIdleTimeout(timeout))
 	...
 }

docs/guide/guide_en.md

@@ -203,7 +203,7 @@ func main() {
 	var conn netpoll.Connection
 	var reader, writer = conn.Reader(), conn.Writer()
 
-	// reading 
+	// reading
 	buf, _ := reader.Next(n)
 	... parse the read data ...
 	reader.Release()
@@ -212,7 +212,7 @@ func main() {
 	var write_data []byte
 	... make the write data ...
 	alloc, _ := writer.Malloc(len(write_data))
-	copy(alloc, write_data) // write data 
+	copy(alloc, write_data) // write data
 	writer.Flush()
 }
 ```
@@ -457,7 +457,7 @@ func main() {
 
 	// or
 
-	// 2. setting with Option 
+	// 2. setting with Option
 	netpoll.NewEventLoop(handler, netpoll.WithReadTimeout(timeout))
 	...
 }
@@ -487,7 +487,7 @@ func main() {
 
 	// or
 
-	// 2. setting with Option 
+	// 2. setting with Option
 	netpoll.NewEventLoop(handler, netpoll.WithIdleTimeout(timeout))
 	...
 }

net_dialer.go

@@ -28,9 +28,9 @@ func DialConnection(network, address string, timeout time.Duration) (connection
 	return defaultDialer.DialConnection(network, address, timeout)
 }
 
-// NewFDConnection create a Connection initialed by any fd
-// It's useful for write unit test for functions have args with the type of netpoll.Connection
-// The typical usage like:
+// NewFDConnection create a Connection initialized by any fd
+// It's useful for writing unit tests for functions that have args with the type of netpoll.Connection
+// The typical usage is like:
 //
 //	rfd, wfd := netpoll.GetSysFdPairs()
 //	rconn, _ = netpoll.NewFDConnection(rfd)

netpoll_unix_test.go

@@ -457,12 +457,12 @@ func TestServerPanicAndClose(t *testing.T) {
 
 	network, address := "tcp", getTestAddress()
 	sendMsg := []byte("hello")
-	var paniced int32
+	var panicked int32
 	loop := newTestEventLoop(network, address,
 		func(ctx context.Context, connection Connection) error {
 			_, err := connection.Reader().Next(len(sendMsg))
 			MustNil(t, err)
-			atomic.StoreInt32(&paniced, 1)
+			atomic.StoreInt32(&panicked, 1)
 			panic("test")
 		},
 	)
@@ -474,7 +474,7 @@ func TestServerPanicAndClose(t *testing.T) {
 	err = conn.Writer().Flush()
 	MustNil(t, err)
 
-	for atomic.LoadInt32(&paniced) == 0 {
+	for atomic.LoadInt32(&panicked) == 0 {
 		runtime.Gosched() // wait for poller close connection
 	}
 	for conn.IsActive() {