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

GH-41673: [Format][Docs] Add arrow format introductory page #41593

Merged
merged 65 commits into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from 64 commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
a1a7b1b
Create skeleton
AlenkaF May 7, 2024
38966af
Add tutorial content for primitive and nested layouts
AlenkaF May 8, 2024
10bf575
Remove headings in columnar description
AlenkaF May 8, 2024
a5a0575
Add rest of the tutorial content
AlenkaF May 8, 2024
2363592
Add diagrams
AlenkaF May 8, 2024
87c70d7
Add missing diagrams
AlenkaF May 9, 2024
22f6468
Add diagrams to rst file and add content for Union
AlenkaF May 9, 2024
fbbfb9f
Correct bitmap of the child array in fixed size list
AlenkaF May 9, 2024
b6baecd
Fix linter error
AlenkaF May 9, 2024
a483d84
Correct typo and add bool, null type info
AlenkaF May 9, 2024
2815b88
Add content for dictionary and eree
AlenkaF May 9, 2024
1d37886
Remove redundant diagrams
AlenkaF May 9, 2024
b66f2c8
Add captions to the spec menu
AlenkaF May 9, 2024
d70d19b
Overall check of the content
AlenkaF May 13, 2024
8522bd2
Fix linter error
AlenkaF May 13, 2024
d6875e2
Remove captions - move to a different PR
AlenkaF May 15, 2024
d190971
Apply suggestions from code review
AlenkaF May 16, 2024
122eb80
Update docs/source/format/FormatIntro.rst
AlenkaF May 16, 2024
4802138
Fix indentation
AlenkaF May 16, 2024
1d5a504
Linter error
AlenkaF May 16, 2024
f953214
Remove system and compression part
AlenkaF May 16, 2024
cd24785
Rename FormatIntro.rst to Intro.rst
AlenkaF May 16, 2024
a4932fb
Update diagrams with undefined symbol and offset correction for strin…
AlenkaF May 21, 2024
9a317e4
Fix left sidebar
AlenkaF May 21, 2024
3f609cc
Move Support for null values before Primitive Layout section
AlenkaF May 21, 2024
8c74029
Move Overview of Arrow Terminology to the beginning and add Physical …
AlenkaF May 21, 2024
0e91dc2
Move Overview back to the end and add a paragraph about array, buffer…
AlenkaF May 23, 2024
e87a730
Clean up extension type examples
AlenkaF May 23, 2024
d8c957a
Remove nanoarrow implementation
AlenkaF May 23, 2024
c277a0f
Apply suggestions from code review
AlenkaF May 23, 2024
1f4df6b
Change C Data Interface section to Sharing Arrow data and add info fo…
AlenkaF May 23, 2024
1233362
Update union diagrams
AlenkaF May 27, 2024
b24b130
Apply suggestions from code review
AlenkaF Jun 4, 2024
0ec252c
utf-8 encoding correction
AlenkaF Jun 10, 2024
848ea6e
Rephrase list type intro
AlenkaF Jun 10, 2024
389bc06
Add note about nulls in ree
AlenkaF Jun 10, 2024
d915eec
Add Field info
AlenkaF Jun 10, 2024
87f73e7
Add java implementation info about table being a list of batches
AlenkaF Jun 10, 2024
8e9e45c
change type to data type and use bold to highlight terms in begining
AlenkaF Jun 10, 2024
4ea0de9
Fix typo - dataactually
AlenkaF Jun 10, 2024
5a56f38
Make changes to Arrow Columnar Fromat sction (tabular data, table, etc.)
AlenkaF Jun 10, 2024
bd80688
Link to the main spec
AlenkaF Jun 10, 2024
17b3b9e
Apply suggestions from code review
AlenkaF Jun 10, 2024
a5c856d
Fix List intro
AlenkaF Jun 10, 2024
52187b8
Fix line lengths
AlenkaF Jun 10, 2024
bc3aa47
Rebase and add a link to table of data types
AlenkaF Jun 10, 2024
e2dc4bf
Change title and update first intro section
AlenkaF Jun 10, 2024
df3a6ce
Add missing paragraph in the intro section
AlenkaF Jun 10, 2024
e101a35
Update union diagrams
AlenkaF Jun 10, 2024
8a59f64
Add a note about bit-endianness
AlenkaF Jun 10, 2024
cd74fe3
Apply suggestions from code review
AlenkaF Jun 18, 2024
1285524
Remove copy of tables vs batch image
Jun 18, 2024
1d82b2e
Add array and buffer connection and validity bitmap representation in…
AlenkaF Sep 17, 2024
fac705c
Add captions to first 3 diagrams
AlenkaF Sep 17, 2024
224159d
Add intro sentence to the var length layout
AlenkaF Sep 17, 2024
ed44b7d
Expand on List View
AlenkaF Sep 17, 2024
581daf3
Revert last paragraph in intro section
AlenkaF Sep 18, 2024
5d74767
Apply suggestions from code review
AlenkaF Sep 25, 2024
8a1abe2
Correct error in run ends array
AlenkaF Sep 25, 2024
2c9cc95
Add info about buffer length in elements vs in bytes
AlenkaF Sep 25, 2024
0141576
Apply suggestions from code review
AlenkaF Sep 26, 2024
2ef6cf7
Update docs/source/format/Intro.rst
AlenkaF Sep 26, 2024
f05c732
Update bool diagram
AlenkaF Sep 26, 2024
a517549
Update ree diagram
AlenkaF Sep 26, 2024
158ee32
Update docs/source/format/Intro.rst
AlenkaF Sep 27, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/source/format/Columnar.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ concepts, here is a small glossary to help disambiguate.
are parametric by construction. A timestamp is also parametric as it needs
a unit (such as microseconds) and a timezone.

.. _data_types:

Data Types
==========

Expand Down
2 changes: 2 additions & 0 deletions docs/source/format/Glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
.. specific language governing permissions and limitations
.. under the License.

.. _glossary:

========
Glossary
========
Expand Down
512 changes: 512 additions & 0 deletions docs/source/format/Intro.rst

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions docs/source/format/images/all-diagrams.svg
AlenkaF marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/source/format/images/bool-diagram.svg
AlenkaF marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/source/format/images/columnar-diagram_1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/source/format/images/columnar-diagram_2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/source/format/images/columnar-diagram_3.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/source/format/images/dense-union-diagram.svg
jorisvandenbossche marked this conversation as resolved.
Show resolved Hide resolved
AlenkaF marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/source/format/images/dictionary-diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
21 changes: 21 additions & 0 deletions docs/source/format/images/fixed-list-diagram.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading