diff options
| author | Philipp Matthias Schaefer <philipp.matthias.schaefer@posteo.de> | 2016-02-29 20:21:39 +0100 |
|---|---|---|
| committer | Philipp Matthias Schaefer <philipp.matthias.schaefer@posteo.de> | 2016-02-29 20:21:39 +0100 |
| commit | d4575c591d6fae32292c9b0a23e44f7f29d935e1 (patch) | |
| tree | dddf672b199a6c3fa1ca7d827ceba9e85e4a46ab /CONVENTIONS.md | |
| parent | da2cb87849e00a7e2413c4103a4f86529fb6e58e (diff) | |
| download | nix-d4575c591d6fae32292c9b0a23e44f7f29d935e1.zip | |
Document naming convention for flag types.
Diffstat (limited to 'CONVENTIONS.md')
| -rw-r--r-- | CONVENTIONS.md | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/CONVENTIONS.md b/CONVENTIONS.md index 4e4a4ab2..8e6a37f9 100644 --- a/CONVENTIONS.md +++ b/CONVENTIONS.md @@ -21,6 +21,8 @@ We do not define integer constants ourselves, but use or reexport them from the We represent sets of constants that are intended to be combined using bitwise operations as parameters to functions by types defined using the `bitflags!` macro from the [bitflags crate][bitflags]. +We name the type for a set of constants whose element's names start with `FOO_` +`FooFlags`. ## Enumerations |