Official stance on getproperty, setproperty! and propertynames and docs #27120
Labels
docs
This change adds or pertains to documentation
needs docs
Documentation for this change is required
It is a bit unclear to me whether those are now the standard way to access type-fields or not? Presumably yes, but then why are they not exported and why are
getfield
,setfield!
andfieldnames
still exported if they should not be used? A clear stance on the "official-ness" of those would be good. Maybe pre-0.7 would be good if exports are to be added/removed.Once that is cleared-up, the docs need updating:
They are missing adequate doc-strings and are almost fully absent from the manual. To cite @stevengj: "We really need more documentation on how to use this, explaining the arguments to getproperty, how to fall back to getfield, implications for performance and type stability, best practices...."
#24960 (comment)
Also, other places, such as https://docs.julialang.org/en/latest/manual/types/#Composite-Types-1 need updating if "properties" are "official".
The text was updated successfully, but these errors were encountered: