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

Open
wants to merge 51 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
51 commits
Select commit Hold shift + click to select a range
83f2aba
Create skeleton
AlenkaF May 7, 2024
7dcb223
Add tutorial content for primitive and nested layouts
AlenkaF May 8, 2024
324ddef
Remove headings in columnar description
AlenkaF May 8, 2024
8f4682e
Add rest of the tutorial content
AlenkaF May 8, 2024
be3c876
Add diagrams
AlenkaF May 8, 2024
96c960c
Add missing diagrams
AlenkaF May 9, 2024
e07e725
Add diagrams to rst file and add content for Union
AlenkaF May 9, 2024
a2e0d38
Correct bitmap of the child array in fixed size list
AlenkaF May 9, 2024
e74b522
Fix linter error
AlenkaF May 9, 2024
ccdf789
Correct typo and add bool, null type info
AlenkaF May 9, 2024
86670da
Add content for dictionary and eree
AlenkaF May 9, 2024
eda77df
Remove redundant diagrams
AlenkaF May 9, 2024
0e40bad
Add captions to the spec menu
AlenkaF May 9, 2024
eaaa80d
Overall check of the content
AlenkaF May 13, 2024
1caf107
Fix linter error
AlenkaF May 13, 2024
ba501c3
Remove captions - move to a different PR
AlenkaF May 15, 2024
9852a26
Apply suggestions from code review
AlenkaF May 16, 2024
291abfd
Update docs/source/format/FormatIntro.rst
AlenkaF May 16, 2024
220af7b
Fix indentation
AlenkaF May 16, 2024
f65c110
Linter error
AlenkaF May 16, 2024
7287b46
Remove system and compression part
AlenkaF May 16, 2024
1a29935
Rename FormatIntro.rst to Intro.rst
AlenkaF May 16, 2024
694d8c6
Update diagrams with undefined symbol and offset correction for strin…
AlenkaF May 21, 2024
d6ed341
Fix left sidebar
AlenkaF May 21, 2024
c41a4af
Move Support for null values before Primitive Layout section
AlenkaF May 21, 2024
62f5abd
Move Overview of Arrow Terminology to the beginning and add Physical …
AlenkaF May 21, 2024
00dbd6b
Move Overview back to the end and add a paragraph about array, buffer…
AlenkaF May 23, 2024
9836bb4
Clean up extension type examples
AlenkaF May 23, 2024
60b0858
Remove nanoarrow implementation
AlenkaF May 23, 2024
4c92a2b
Apply suggestions from code review
AlenkaF May 23, 2024
1677bb3
Change C Data Interface section to Sharing Arrow data and add info fo…
AlenkaF May 23, 2024
0835554
Update union diagrams
AlenkaF May 27, 2024
698b5d8
Apply suggestions from code review
AlenkaF Jun 4, 2024
b074517
utf-8 encoding correction
AlenkaF Jun 10, 2024
eaaa61f
Rephrase list type intro
AlenkaF Jun 10, 2024
3b7937d
Add note about nulls in ree
AlenkaF Jun 10, 2024
fdc93d6
Add Field info
AlenkaF Jun 10, 2024
adf53b2
Add java implementation info about table being a list of batches
AlenkaF Jun 10, 2024
bd7b3ba
change type to data type and use bold to highlight terms in begining
AlenkaF Jun 10, 2024
9f04bb3
Fix typo - dataactually
AlenkaF Jun 10, 2024
95e7af5
Make changes to Arrow Columnar Fromat sction (tabular data, table, etc.)
AlenkaF Jun 10, 2024
8e7369d
Link to the main spec
AlenkaF Jun 10, 2024
c176847
Apply suggestions from code review
AlenkaF Jun 10, 2024
5cd5796
Fix List intro
AlenkaF Jun 10, 2024
45049a7
Fix line lengths
AlenkaF Jun 10, 2024
5dae2f0
Rebase and add a link to table of data types
AlenkaF Jun 10, 2024
3c8b4fa
Change title and update first intro section
AlenkaF Jun 10, 2024
f330074
Add missing paragraph in the intro section
AlenkaF Jun 10, 2024
2524fda
Update union diagrams
AlenkaF Jun 10, 2024
9f9bbff
Add a note about bit-endianness
AlenkaF Jun 10, 2024
a8df75c
Apply suggestions from code review
AlenkaF Jun 18, 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/CanonicalExtensions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,8 @@ JSON
In the future, additional fields may be added, but they are not required
to interpret the array.

.. _uuid_extension:

UUID
====

Expand Down
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
Loading
Loading