Describe getting the base type of a bitflag

Duplicates improvement made to Base's Enums: JuliaLang/julia#36057
jmert · Sep 9, 2020 · 5879cbd · 5879cbd
1 parent 7f6276a
commit 5879cbd
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/BitFlags.jl b/src/BitFlags.jl
@@ -115,7 +115,8 @@ end
 
 `BaseType`, which defaults to [`UInt32`](@ref), must be a primitive subtype of `Unsigned`.
 Member values can be converted between the bit flag type and `BaseType`. `read` and `write`
-perform these conversions automatically.
+perform these conversions automatically. In case the bitflag is created with a non-default
+`BaseType`, `Integer(value1)` will return the integer `value1` with the type `BaseType`.
 
 To list all the instances of an bitflag use `instances`, e.g.