Skip to content

Commit 876cad6

Browse files
committed
edit README
1 parent 37eff32 commit 876cad6

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,9 @@ As of Version 1, supported field types are
219219
(e.g. `type RFC791InternetHeaderPrecedence uint8`)
220220
having the above underlying types are compatible.
221221

222+
A word struct cannot be marshalled/unmarshalled by itself;
223+
it must be a field in a format struct, explained below.
224+
222225
##### Offset
223226
`<offset>` is an integer
224227
representing the number of places the bit field should be shifted left
@@ -246,6 +249,9 @@ type RFC791InternetHeaderFormatWithoutOptions struct {
246249
}
247250
```
248251

252+
`Marshal()` and `Unmarshal()` expect a pointer to a format struct
253+
as an argument.
254+
249255
### Example
250256
```go
251257
package main

0 commit comments

Comments
 (0)