Add README and docstrings for Julia API #17
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nickrobinson251
force-pushed
the
npr-docs
branch
2 times, most recently
from
d1c712a to
2d67553
Compare
nickrobinson251
force-pushed
the
npr-docs
branch
from
a11428e to
9048cf6
Compare
nickrobinson251
changed the title
nickrobinson251
commented
Jan 10, 2024
jfunstonRAI
approved these changes
Jan 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a README that covers basic usage, some design info, and development/contributing guidance.
I've left some aspect of the design section with as
TODO, because Justin or Andre are probably best placed to fill those out (in a follow-up PR or whenever the design is more settled if it is still in flux).I've also added documentation to the public Julia API, and cleaned it up a little bit, but have resisted the temptation to make any breaking changes.
(p.s. i also added a README to https://github.com/relationalAI/object_store_ffi)