Skip to content

Commit

Permalink
document reconstruct limitations
Browse files Browse the repository at this point in the history
  • Loading branch information
rafaqz committed Jan 7, 2019
1 parent 2cc2b0e commit f564dcd
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -21,6 +21,9 @@ lists of fieldnames and types that may be useful for building parameter display
tables. Any user-defined function of the form `func(::T, ::Type{Val{fn}}) = ` can be used in `metaflatten`,
where T is the struct type and fn is the fieldname symbol.

One limitation of using `reconstruct` is that it requires an inner consstructor that accept all fields in the order they come in the type.
If some fields are recalculated at construction time, they should be calculateed in this final inner constructor.

[UnitlessFlatten.jl](https://github.com/rafaqz/UnitlessFlatten.jl) extends Flatten.jl to automatically strip and add Unitful units.

This basis of this package was originally written by Robin Deits (@rdeits). The current form
Expand Down

0 comments on commit f564dcd

Please sign in to comment.