Skip to content

Commit 8a55f0d

Browse files
committed
docs: autoupdate
1 parent b1fa24a commit 8a55f0d

1 file changed

Lines changed: 42 additions & 24 deletions

File tree

README.md

Lines changed: 42 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</a>
1717

1818
<a href="https://codecov.io/gh/atomicgo/assert">
19-
<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-123-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
19+
<!-- unittestcount:start --><img src="https://img.shields.io/badge/Unit_Tests-136-magenta?style=flat-square" alt="Unit test count"><!-- unittestcount:end -->
2020
</a>
2121

2222
<a href="https://opensource.org/licenses/MIT" target="_blank">
@@ -73,109 +73,127 @@ Package assert provides a set of assertion functions.
7373

7474
## Index
7575

76-
- [func Contains[T any](s []T, v T) bool](<#func-contains>)
77-
- [func ContainsAll[T any](s []T, v []T) bool](<#func-containsall>)
78-
- [func ContainsAny[T any](s []T, v []T) bool](<#func-containsany>)
79-
- [func ContainsNone[T any](s []T, v []T) bool](<#func-containsnone>)
76+
- [func Contains(a any, b any) bool](<#func-contains>)
77+
- [func ContainsAll[T any](a T, v []T) bool](<#func-containsall>)
78+
- [func ContainsAny[T any](a T, v []T) bool](<#func-containsany>)
79+
- [func ContainsNone[T any](a T, v []T) bool](<#func-containsnone>)
8080
- [func Equal[T any](a, b T) bool](<#func-equal>)
8181
- [func Implements(a, iface any) bool](<#func-implements>)
8282
- [func Kind(a any, kind reflect.Kind) bool](<#func-kind>)
83+
- [func Lowercase(s string) bool](<#func-lowercase>)
8384
- [func Nil(a any) bool](<#func-nil>)
8485
- [func Number(a any) bool](<#func-number>)
8586
- [func Panic(f func()) (panicked bool)](<#func-panic>)
8687
- [func Unique[T any](s []T) bool](<#func-unique>)
88+
- [func Uppercase(s string) bool](<#func-uppercase>)
8789
- [func Zero(a any) bool](<#func-zero>)
8890

8991

90-
## func [Contains](<https://github.com/atomicgo/assert/blob/main/assert.go#L91>)
92+
## func [Contains](<https://github.com/atomicgo/assert/blob/main/assert.go#L93>)
9193

9294
```go
93-
func Contains[T any](s []T, v T) bool
95+
func Contains(a any, b any) bool
9496
```
9597

96-
Contains returns true if the slice contains the value. Items are considered equal if they are deep equal.
98+
Contains returns true if a contains b.
9799

98-
## func [ContainsAll](<https://github.com/atomicgo/assert/blob/main/assert.go#L104>)
100+
## func [ContainsAll](<https://github.com/atomicgo/assert/blob/main/assert.go#L113>)
99101

100102
```go
101-
func ContainsAll[T any](s []T, v []T) bool
103+
func ContainsAll[T any](a T, v []T) bool
102104
```
103105

104-
ContainsAll returns true if the slice contains all the values. Items are considered equal if they are deep equal.
106+
ContainsAll returns true if all values are contained in a.
105107

106108
## func [ContainsAny](<https://github.com/atomicgo/assert/blob/main/assert.go#L124>)
107109

108110
```go
109-
func ContainsAny[T any](s []T, v []T) bool
111+
func ContainsAny[T any](a T, v []T) bool
110112
```
111113

112-
ContainsAny returns true if the slice contains any of the values. Items are considered equal if they are deep equal.
114+
ContainsAny returns true if any of the values are contained in a.
113115

114-
## func [ContainsNone](<https://github.com/atomicgo/assert/blob/main/assert.go#L139>)
116+
## func [ContainsNone](<https://github.com/atomicgo/assert/blob/main/assert.go#L135>)
115117

116118
```go
117-
func ContainsNone[T any](s []T, v []T) bool
119+
func ContainsNone[T any](a T, v []T) bool
118120
```
119121

120-
ContainsNone returns true if the slice contains none of the values. Items are considered equal if they are deep equal.
122+
ContainsNone returns true if none of the values are contained in a.
121123

122-
## func [Equal](<https://github.com/atomicgo/assert/blob/main/assert.go#L6>)
124+
## func [Equal](<https://github.com/atomicgo/assert/blob/main/assert.go#L9>)
123125

124126
```go
125127
func Equal[T any](a, b T) bool
126128
```
127129

128130
Equal compares two values and returns true if they are equal.
129131

130-
## func [Implements](<https://github.com/atomicgo/assert/blob/main/assert.go#L50>)
132+
## func [Implements](<https://github.com/atomicgo/assert/blob/main/assert.go#L53>)
131133

132134
```go
133135
func Implements(a, iface any) bool
134136
```
135137

136138
Implements returns true if the value implements the interface.
137139

138-
## func [Kind](<https://github.com/atomicgo/assert/blob/main/assert.go#L11>)
140+
## func [Kind](<https://github.com/atomicgo/assert/blob/main/assert.go#L14>)
139141

140142
```go
141143
func Kind(a any, kind reflect.Kind) bool
142144
```
143145

144146
Kind returns true if the value is of the given kind.
145147

146-
## func [Nil](<https://github.com/atomicgo/assert/blob/main/assert.go#L16>)
148+
## func [Lowercase](<https://github.com/atomicgo/assert/blob/main/assert.go#L151>)
149+
150+
```go
151+
func Lowercase(s string) bool
152+
```
153+
154+
Lowercase returns true if the string is lowercase.
155+
156+
## func [Nil](<https://github.com/atomicgo/assert/blob/main/assert.go#L19>)
147157

148158
```go
149159
func Nil(a any) bool
150160
```
151161

152162
Nil returns true if the value is nil.
153163

154-
## func [Number](<https://github.com/atomicgo/assert/blob/main/assert.go#L30>)
164+
## func [Number](<https://github.com/atomicgo/assert/blob/main/assert.go#L33>)
155165

156166
```go
157167
func Number(a any) bool
158168
```
159169

160170
Number returns true if the value is a number.
161171

162-
## func [Panic](<https://github.com/atomicgo/assert/blob/main/assert.go#L64>)
172+
## func [Panic](<https://github.com/atomicgo/assert/blob/main/assert.go#L67>)
163173

164174
```go
165175
func Panic(f func()) (panicked bool)
166176
```
167177

168178
Panic returns true if the function panics.
169179

170-
## func [Unique](<https://github.com/atomicgo/assert/blob/main/assert.go#L76>)
180+
## func [Unique](<https://github.com/atomicgo/assert/blob/main/assert.go#L79>)
171181

172182
```go
173183
func Unique[T any](s []T) bool
174184
```
175185

176186
Unique returns true if the slice contains unique values. Items are considered unique if they are not deep equal.
177187

178-
## func [Zero](<https://github.com/atomicgo/assert/blob/main/assert.go#L45>)
188+
## func [Uppercase](<https://github.com/atomicgo/assert/blob/main/assert.go#L146>)
189+
190+
```go
191+
func Uppercase(s string) bool
192+
```
193+
194+
Uppercase returns true if the string is uppercase.
195+
196+
## func [Zero](<https://github.com/atomicgo/assert/blob/main/assert.go#L48>)
179197

180198
```go
181199
func Zero(a any) bool

0 commit comments

Comments
 (0)