blackteay/gin
3
0
Fork 0
mirror of https://github.com/gin-gonic/gin.git synced 2026-06-06 03:08:11 +08:00
Code Issues Projects Releases Wiki Activity

fix(docs): correct grammar and missing punctuation in doc.md

Browse Source 
- Fix 'detail information' → 'detailed information' (6 occurrences)
- Fix 'detail example code' → 'detailed example code' (1 occurrence)
- Add missing closing quote in BasicAuth example comment
This commit is contained in:
Sediman 2026-05-27 06:07:51 +02:00
parent 5f4f964325
commit 953cf9948b
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/doc.md
View File

@ -108,7 +108,7 @@ Gin enables `MsgPack` rendering feature by default. But you can disable this fea
go build -tags=nomsgpack .
```
This is useful to reduce the binary size of executable files. See the [detail information](https://github.com/gin-gonic/gin/pull/1852).
This is useful to reduce the binary size of executable files. See the [detailed information](https://github.com/gin-gonic/gin/pull/1852).
## Routing
@ -275,7 +275,7 @@ ids: map[b:hello a:1234]; names: map[second:tianou first:thinkerou]
#### Single file
References issue [#774](https://github.com/gin-gonic/gin/issues/774) and detail [example code](https://github.com/gin-gonic/examples/tree/master/upload-file/single).
References issue [#774](https://github.com/gin-gonic/gin/issues/774) and detailed [example code](https://github.com/gin-gonic/examples/tree/master/upload-file/single).
`file.Filename` **SHOULD NOT** be trusted. See [`Content-Disposition` on MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Disposition#Directives) and [#1693](https://github.com/gin-gonic/gin/issues/1693)
@ -556,7 +556,7 @@ func main() {
}))
// /admin/secrets endpoint
// hit "localhost:8080/admin/secrets
// hit "localhost:8080/admin/secrets"
authorized.GET("/secrets", func(c *gin.Context) {
// get user, it was set by the BasicAuth middleware
user := c.MustGet(gin.AuthUserKey).(string)
@ -998,7 +998,7 @@ See the [struct-lvl-validation example](https://github.com/gin-gonic/examples/tr
### Only Bind Query String
`ShouldBindQuery` function only binds the query params and not the post data. See the [detail information](https://github.com/gin-gonic/gin/issues/742#issuecomment-315953017).
`ShouldBindQuery` function only binds the query params and not the post data. See the [detailed information](https://github.com/gin-gonic/gin/issues/742#issuecomment-315953017).
```go
package main
@ -1035,7 +1035,7 @@ func startPage(c *gin.Context) {
### Bind Query String or Post Data
See the [detail information](https://github.com/gin-gonic/gin/issues/742#issuecomment-264681292).
See the [detailed information](https://github.com/gin-gonic/gin/issues/742#issuecomment-264681292).
```go
package main
@ -1191,7 +1191,7 @@ curl -X GET "localhost:8085/testing?name=appleboy&addresses=foo,bar&birthday=199
### Bind Uri
See the [detail information](https://github.com/gin-gonic/gin/issues/846).
See the [detailed information](https://github.com/gin-gonic/gin/issues/846).
```go
package main
@ -1379,7 +1379,7 @@ func main() {
### Bind HTML checkboxes
See the [detail information](https://github.com/gin-gonic/gin/issues/129#issuecomment-124260092)
See the [detailed information](https://github.com/gin-gonic/gin/issues/129#issuecomment-124260092).
main.go
@ -2413,7 +2413,7 @@ func main() {
### http2 server push
http.Pusher is supported only **go1.8+**. See the [golang blog](https://go.dev/blog/h2push) for detail information.
http.Pusher is supported only **go1.8+**. See the [golang blog](https://go.dev/blog/h2push) for detailed information.
```go
package main