-
Notifications
You must be signed in to change notification settings - Fork 41
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Docs: improve copy-vs-view, mutability, and advanced API #225
Conversation
In the "counterintuitive" section, the documentation formerly mixed together two concepts: mutable structs and the copying behavior when constructing a StructArray from an Array-of-Structs. This commit disentagles these concepts.
This PR increases the verbosity of the "advanced techniques" page of the documentation. The intent to be more explicit about what occurs with default behavior, and how customizations yield a different outcome. In some ways this is unfinished: the portion of these docs involving `Location` may be a bug in StructArrays. I didn't touch this section of the documentation.
Given changes in printing over time, I'd recommend we disable doctesting on Julia 1.3. |
Also adds Julia 1.6LTS to the CI matrix.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR @timholy! I really like the new docs on modifying struct fields, and the additional documentation of AOS storage is helpful. I just added two small suggestions.
I didn't realize that there was a |
Co-authored-by: Jesse Chan <[email protected]>
Good idea. I can try to add your point to these docs too. |
OK, I introduced the |
@johnnychen94 is pioneering a move of StructArrays into JuliaImages and I was taking a look at the package. The documentation is quite good, but (as usual) can be even better, and so I thought I'd leverage my "newbie" status to do some good for the community.
This revision attempts to address the following perceived issues:
The advanced API section might need further revisions; I think the portion of the demo involving
Location
might simply be a bug in StructArrays, but I haven't delved deeply. In any case,meta_table(s)
throws an error so the demo doesn't work.This also uses doctests more heavily to make sure the demos actually work.
Would appreciate a review from @piever and/or @jlchan if possible.