Skip to content

docs: format readme #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: format readme #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 15 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,17 @@ Struct tag syntax spec:
```
type T struct {
// Single model
Field1 T1 `tagName:"expression"`
Field1 T1 `tagName:"expression"`

// Multiple model
Field2 T2 `tagName:"exprName:expression; [exprName2:expression2;]..."`
Field2 T2 `tagName:"exprName:expression; [exprName2:expression2;]..."`

// Omit it
Field3 T3 `tagName:"-"`
// Omit it when it is nil
Field4 T4 `tagName:"?"`
...
Field3 T3 `tagName:"-"`

// Omit it when it is nil
Field4 T4 `tagName:"?"`
...
}
```

Expand Down Expand Up @@ -172,15 +175,15 @@ field_lv1.field_lv2...field_lvn

- If expression is **single model** or exprName is `@`:

```
field_lv1.field_lv2...field_lvn
```
```
field_lv1.field_lv2...field_lvn
```

- If expression is **multiple model** and exprName is not `@`:

```
field_lv1.field_lv2...field_lvn@exprName
```
```
field_lv1.field_lv2...field_lvn@exprName
```

## Benchmark

Expand Down