search

JuliaData / StructTypes.jl

Abstract definitions and convenience methods for describing, processing, and constructing Julia objects
https://juliadata.github.io/StructTypes.jl/stable/
MIT License
80 stars 22 forks source link

missing docstring warning #54

Closed rapus95 closed 3 years ago

rapus95 commented 3 years ago

https://juliadata.github.io/StructTypes.jl/stable/#StructTypes.OrderedStruct

quinnj commented 3 years ago

Thanks for the report! Turns out we don't need that reference in the manual since we're already referencing StructTypes.Struct.

rapus95 commented 3 years ago

sure but shouldn't there at least be a note about it being the same as UnorderedStruct? Especially given that Struct is just defaulting to Unordered right now? So the better way would be to properly document UnorderedStruct and then document Struct as defaulting to UnorderedStruct for compatibility reasons and might change in some major version. So that people learn to use the definitions properly 🙈 Also to remove that ugly build warning/error from the documentation. Because right now that looks unintended. 😅