-
Notifications
You must be signed in to change notification settings - Fork 44
Set up Documenter #158
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
Set up Documenter #158
Conversation
f796bd4
to
aa53755
Compare
86d721e
to
1000e0f
Compare
1000e0f
to
08e674f
Compare
There's more that can be added, but this feels like a good start. |
NamedTuple{names, map_params(f, types)} | ||
|
||
""" | ||
StructArrays._map_params(f, T) |
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.
Now that it is documented, it feels really odd that the API to map a function to a (Named)Tuple
type returns a type or an object depending on an underscore... Even though it's internal, it may be worth to rename it (don't have great ideas though), but that should probably be done in another PR.
Thanks a lot, this looks great! I've added the documenter key. From what I understand, |
I wonder whether we should keep the README as is, or maybe it could be moved to a "tutorial" section of the docs. Somehow, I think that it's helpful to have a quick way of learning how to use the package without going through the API. |
It will require setting up the necessary documenter keys, unfortunately I don't have access to the repo.