search

Seelengrab / FieldFlags.jl

A small package for creating bitfield-like structs.
https://seelengrab.github.io/FieldFlags.jl/
MIT License
11 stars 0 forks source link

Some parts of documentation outdated? #14

Closed trahflow closed 3 months ago

trahflow commented 3 months ago

The documentation mentions a zero-arg constructor for @bitflags types. But both, the example in the documentation and a local test (on version 0.4.0) show that such a constructor doesn't exist. Maybe just a matter of updating the docs?

trahflow commented 3 months ago

Documentation also says

[...] While currently field sizes larger than 1 return an UInt, this is in particular not guaranteed and may be changed in the future, so that e.g. a field of size 2 returns an UInt8 instead.

This also seems to have changed already?

Btw. Really nice package! :)

Seelengrab commented 3 months ago

Oof, yes 🤦 Seems like I missed parts of the docs with the last release https://github.com/Seelengrab/FieldFlags.jl/releases/tag/v0.4.0

I'll fix the docs shortly!

Seelengrab commented 3 months ago

Alright, docs are fixed! Thanks for reporting this :)

trahflow commented 3 months ago

thanks for the super quick reaction!