mirror
/
enumer
mirror of https://github.com/dmarkham/enumer.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Correct some typos

This commit is contained in:
Alvaro Lopez Espinosa 2018-03-09 14:47:25 +00:00
parent d213131f3e
commit f6af706459
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -5,7 +5,7 @@ It started as a fork of [Rob Pike’s Stringer tool](https://godoc.org/golang.or
## Generated functions and methods ## Generated functions and methods
When Enumer is applied to a type, it will generate: When Enumer is applied to a type, it will generate:
* The following basic methods/function: * The following basic methods/functions:
* Method `String()`: returns the string representation of the enum value. This makes the enum conform * Method `String()`: returns the string representation of the enum value. This makes the enum conform
the `Stringer` interface, so whenever you print an enum value, you'll get the string name instead of a number. the `Stringer` interface, so whenever you print an enum value, you'll get the string name instead of a number.
@ -13,7 +13,7 @@ the `Stringer` interface, so whenever you print an enum value, you'll get the st
when you need to read enum values from command line arguments, from a configuration file, or when you need to read enum values from command line arguments, from a configuration file, or
from a REST API request... In short, from those places where using the real enum value (an integer) would from a REST API request... In short, from those places where using the real enum value (an integer) would
be almost meaningless or hard to trace or use by a human. be almost meaningless or hard to trace or use by a human.
* Function `<Type>Values()`: returns a slice with all the value of the enum * Function `<Type>Values()`: returns a slice with all the values of the enum
* Method `IsA<Type>()`: returns true only if the current value is among the values of the enum. Useful for validations. * Method `IsA<Type>()`: returns true only if the current value is among the values of the enum. Useful for validations.
* When the flag `json` is provided, two additional methods will be generated, `MarshalJSON()` and `UnmarshalJSON()`. These make * When the flag `json` is provided, two additional methods will be generated, `MarshalJSON()` and `UnmarshalJSON()`. These make
the enum conform to the `json.Marshaler` and `json.Unmarshaler` interfaces. Very useful to use it in JSON APIs. the enum conform to the `json.Marshaler` and `json.Unmarshaler` interfaces. Very useful to use it in JSON APIs.