Skip to content

Conversation

simonbyrne
Copy link
Contributor

It will require setting up the necessary documenter keys, unfortunately I don't have access to the repo.

@simonbyrne simonbyrne force-pushed the sb/documenter branch 2 times, most recently from 86d721e to 1000e0f Compare December 6, 2020 04:59
@simonbyrne simonbyrne marked this pull request as ready for review December 6, 2020 05:16
@simonbyrne
Copy link
Contributor Author

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)
Copy link
Collaborator

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.

@piever
Copy link
Collaborator

piever commented Dec 7, 2020

Thanks a lot, this looks great! I've added the documenter key. From what I understand, push_preview doesn't work because the PR comes from a fork and not from a branch of the main repo, but I've checked the docs locally.

@piever piever merged commit 569502e into JuliaArrays:master Dec 7, 2020
@piever
Copy link
Collaborator

piever commented Dec 7, 2020

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.

@simonbyrne simonbyrne deleted the sb/documenter branch December 8, 2020 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants