Skip to content
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

Document/publish our arrow schemas #6818

Closed
jleibs opened this issue Jul 8, 2024 · 0 comments · Fixed by #7986
Closed

Document/publish our arrow schemas #6818

jleibs opened this issue Jul 8, 2024 · 0 comments · Fixed by #7986
Assignees
Labels
📖 documentation Improvements or additions to documentation

Comments

@jleibs
Copy link
Member

jleibs commented Jul 8, 2024

However, so far the arrow data has been an implicit implementation detail sitting behind our object-APIs. To make this data accessible we need to be able to show users how to work with it.

Unfortunately, there is no standard textual representation of an arrow schema. Although we have our own fbs files, this is a Rerun-specific implementation detail that is not necessarily familiar to those attempting to cross-reference with arrow documentation.

For each Rerun datatype, we should generate a doc page specifically focused on the arrow schema:

  • The terms used should as closely as possible matches the official terms from the arrow documentation for the native libraries.
  • We should include a generated code snippet in each of the 3 languages that produces the corresponding arrow datatype. Note that we already generate this code in our serializers. We just need to emit that same code into a block in the doc pages.

We also need to formalize the documentation around any additional meta-data required for interpretation as a component or inclusion into a chunk.

@jleibs jleibs added the 📖 documentation Improvements or additions to documentation label Jul 8, 2024
@emilk emilk self-assigned this Nov 4, 2024
@emilk emilk mentioned this issue Nov 4, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants