Skip to content
This repository was archived by the owner on Dec 6, 2022. It is now read-only.

Commit 17724dd

Browse files
committed
Update readme
1 parent 18f8fa1 commit 17724dd

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Go Report Card](https://goreportcard.com/badge/github.com/mbilski/exhaustivestruct)](https://goreportcard.com/badge/github.com/mbilski/exhaustivestruct)
44

5-
exhaustivestruct is a go static analysis tool to find structs that have some, but no all, initialized fields.
5+
exhaustivestruct is a go static analysis tool to find structs that have uninitialized fields.
66

77
> :warning: This linter is meant to be used only for special cases.
88
> It is not recommended to use it for all files in a project.
@@ -16,7 +16,11 @@ go get -u github.com/mbilski/exhaustivestruct/cmd/exhaustivestruct
1616
## Usage
1717

1818
```
19-
exhaustivestruct files/packages
19+
Usage: exhaustivestruct [-flag] [package]
20+
21+
Flags:
22+
-struct_patterns string
23+
This is a comma separated list of expressions to match struct packages and names
2024
```
2125

2226
## Example
@@ -30,7 +34,5 @@ type User struct {
3034
var user = User{ // fails with "Age is missing in User"
3135
Name: "John",
3236
}
33-
34-
var user2 = User{} // ignores empty structs
3537
```
3638

main

7.1 MB
Binary file not shown.

0 commit comments

Comments
 (0)