This is an automated email from the ASF dual-hosted git repository.
quinnj pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-julia.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 4f00d72 build based on 2696105
4f00d72 is described below
commit 4f00d728faa7b91d78d17e466704df3e847eced8
Author: Documenter.jl <[email protected]>
AuthorDate: Wed Aug 28 16:34:40 2024 +0000
build based on 2696105
---
dev/.documenter-siteinfo.json | 2 +-
dev/assets/documenter.js | 53 +++++++++++++++++++++++-------------------
dev/index.html | 2 +-
dev/manual/index.html | 2 +-
dev/objects.inv | Bin 1224 -> 1224 bytes
dev/reference/index.html | 12 +++++-----
6 files changed, 38 insertions(+), 33 deletions(-)
diff --git a/dev/.documenter-siteinfo.json b/dev/.documenter-siteinfo.json
index 60059cf..647375b 100644
--- a/dev/.documenter-siteinfo.json
+++ b/dev/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-12T20:30:48","documenter_version":"1.5.0"}}
\ No newline at end of file
+{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-28T16:34:35","documenter_version":"1.6.0"}}
\ No newline at end of file
diff --git a/dev/assets/documenter.js b/dev/assets/documenter.js
index b2bdd43..82252a1 100644
--- a/dev/assets/documenter.js
+++ b/dev/assets/documenter.js
@@ -77,30 +77,35 @@ require(['jquery'], function($) {
let timer = 0;
var isExpanded = true;
-$(document).on("click", ".docstring header", function () {
- let articleToggleTitle = "Expand docstring";
-
- debounce(() => {
- if ($(this).siblings("section").is(":visible")) {
- $(this)
- .find(".docstring-article-toggle-button")
- .removeClass("fa-chevron-down")
- .addClass("fa-chevron-right");
- } else {
- $(this)
- .find(".docstring-article-toggle-button")
- .removeClass("fa-chevron-right")
- .addClass("fa-chevron-down");
+$(document).on(
+ "click",
+ ".docstring .docstring-article-toggle-button",
+ function () {
+ let articleToggleTitle = "Expand docstring";
+ const parent = $(this).parent();
+
+ debounce(() => {
+ if (parent.siblings("section").is(":visible")) {
+ parent
+ .find("a.docstring-article-toggle-button")
+ .removeClass("fa-chevron-down")
+ .addClass("fa-chevron-right");
+ } else {
+ parent
+ .find("a.docstring-article-toggle-button")
+ .removeClass("fa-chevron-right")
+ .addClass("fa-chevron-down");
- articleToggleTitle = "Collapse docstring";
- }
+ articleToggleTitle = "Collapse docstring";
+ }
- $(this)
- .find(".docstring-article-toggle-button")
- .prop("title", articleToggleTitle);
- $(this).siblings("section").slideToggle();
- });
-});
+ parent
+ .children(".docstring-article-toggle-button")
+ .prop("title", articleToggleTitle);
+ parent.siblings("section").slideToggle();
+ });
+ }
+);
$(document).on("click", ".docs-article-toggle-button", function (event) {
let articleToggleTitle = "Expand docstring";
@@ -110,7 +115,7 @@ $(document).on("click", ".docs-article-toggle-button",
function (event) {
debounce(() => {
if (isExpanded) {
$(this).removeClass("fa-chevron-up").addClass("fa-chevron-down");
- $(".docstring-article-toggle-button")
+ $("a.docstring-article-toggle-button")
.removeClass("fa-chevron-down")
.addClass("fa-chevron-right");
@@ -119,7 +124,7 @@ $(document).on("click", ".docs-article-toggle-button",
function (event) {
$(".docstring section").slideUp(animationSpeed);
} else {
$(this).removeClass("fa-chevron-down").addClass("fa-chevron-up");
- $(".docstring-article-toggle-button")
+ $("a.docstring-article-toggle-button")
.removeClass("fa-chevron-right")
.addClass("fa-chevron-down");
diff --git a/dev/index.html b/dev/index.html
index 345ac9c..85bfcea 100644
--- a/dev/index.html
+++ b/dev/index.html
@@ -1,2 +1,2 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport"
content="width=device-width, initial-scale=1.0"/><title>Home ·
Arrow.jl</title><meta name="title" content="Home · Arrow.jl"/><meta
property="og:title" content="Home · Arrow.jl"/><meta property="twitter:title"
content="Home · Arrow.jl"/><meta name="description" content="Documentation for
Arrow.jl."/><meta property="og:description" content="Documentation for
Arrow.jl."/><meta property="twitter:description" content="Document [...]
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport"
content="width=device-width, initial-scale=1.0"/><title>Home ·
Arrow.jl</title><meta name="title" content="Home · Arrow.jl"/><meta
property="og:title" content="Home · Arrow.jl"/><meta property="twitter:title"
content="Home · Arrow.jl"/><meta name="description" content="Documentation for
Arrow.jl."/><meta property="og:description" content="Documentation for
Arrow.jl."/><meta property="twitter:description" content="Document [...]
diff --git a/dev/manual/index.html b/dev/manual/index.html
index 2c1b977..b4ab5ab 100644
--- a/dev/manual/index.html
+++ b/dev/manual/index.html
@@ -50,4 +50,4 @@ Arrow.write(io, tbl_parts)
# treat an array of csv files with same schema where each file is a partition
# in this form, a function `CSV.File` is applied to each element of 2nd
argument
csv_parts = Tables.partitioner(CSV.File, csv_files)
-Arrow.write(io, csv_parts)</code></pre><h3 id="Arrow.Writer"><a
class="docs-heading-anchor"
href="#Arrow.Writer"><code>Arrow.Writer</code></a><a id="Arrow.Writer-1"></a><a
class="docs-heading-anchor-permalink" href="#Arrow.Writer"
title="Permalink"></a></h3><p>With <code>Arrow.Writer</code>, you instantiate
an <code>Arrow.Writer</code> object, write sources using it, and then close it.
This allows for incrmental writes to the same sink. It is similar to
<code>Arrow.append</code> withou [...]
+Arrow.write(io, csv_parts)</code></pre><h3 id="Arrow.Writer"><a
class="docs-heading-anchor"
href="#Arrow.Writer"><code>Arrow.Writer</code></a><a id="Arrow.Writer-1"></a><a
class="docs-heading-anchor-permalink" href="#Arrow.Writer"
title="Permalink"></a></h3><p>With <code>Arrow.Writer</code>, you instantiate
an <code>Arrow.Writer</code> object, write sources using it, and then close it.
This allows for incrmental writes to the same sink. It is similar to
<code>Arrow.append</code> withou [...]
diff --git a/dev/objects.inv b/dev/objects.inv
index 7147028..70f6eb3 100644
Binary files a/dev/objects.inv and b/dev/objects.inv differ
diff --git a/dev/reference/index.html b/dev/reference/index.html
index 480c1cc..d77497a 100644
--- a/dev/reference/index.html
+++ b/dev/reference/index.html
@@ -1,11 +1,11 @@
<!DOCTYPE html>
-<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport"
content="width=device-width, initial-scale=1.0"/><title>API Reference ·
Arrow.jl</title><meta name="title" content="API Reference · Arrow.jl"/><meta
property="og:title" content="API Reference · Arrow.jl"/><meta
property="twitter:title" content="API Reference · Arrow.jl"/><meta
name="description" content="Documentation for Arrow.jl."/><meta
property="og:description" content="Documentation for Arrow.jl."/><meta
property="tw [...]
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport"
content="width=device-width, initial-scale=1.0"/><title>API Reference ·
Arrow.jl</title><meta name="title" content="API Reference · Arrow.jl"/><meta
property="og:title" content="API Reference · Arrow.jl"/><meta
property="twitter:title" content="API Reference · Arrow.jl"/><meta
name="description" content="Documentation for Arrow.jl."/><meta
property="og:description" content="Documentation for Arrow.jl."/><meta
property="tw [...]
Arrow.Stream(file::String; convert::Bool=true)
Arrow.Stream(bytes::Vector{UInt8}, pos=1, len=nothing; convert::Bool=true)
-Arrow.Stream(inputs::Vector; convert::Bool=true)</code></pre><p>Start reading
an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read
all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be
read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input [...]
+Arrow.Stream(inputs::Vector; convert::Bool=true)</code></pre><p>Start reading
an arrow formatted table, from:</p><ul><li><code>io</code>, bytes will be read
all at once via <code>read(io)</code></li><li><code>file</code>, bytes will be
read via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input [...]
Arrow.Table(file::String; convert::Bool=true)
Arrow.Table(bytes::Vector{UInt8}, pos=1, len=nothing; convert::Bool=true)
-Arrow.Table(inputs::Vector; convert::Bool=true)</code></pre><p>Read an arrow
formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at
once via <code>read(io)</code></li><li><code>file</code>, bytes will be read
via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input should be [...]
+Arrow.Table(inputs::Vector; convert::Bool=true)</code></pre><p>Read an arrow
formatted table, from:</p><ul><li><code>io</code>, bytes will be read all at
once via <code>read(io)</code></li><li><code>file</code>, bytes will be read
via <code>Mmap.mmap(file)</code></li><li><code>bytes</code>, a byte vector
directly, optionally allowing specifying the starting byte position
<code>pos</code> and <code>len</code></li><li>A <code>Vector</code> of any of
the above, in which each input should be [...]
julia> partition1 = (col1 = [1, 2], col2 = ["A", "B"])
(col1 = [1, 2], col2 = ["A", "B"])
@@ -22,8 +22,8 @@ julia> close(writer)</code></pre><p>It's also possible
to automatically c
Arrow.write(writer, partition1)
partition2 = (col1 = [3, 4], col2 = ["C", "D"])
Arrow.write(writer, partition2)
- end</code></pre></div><a class="docs-sourcelink" target="_blank"
href="https://github.com/apache/arrow-julia/blob/2a3c8b91b13cc1ccf7b1c218e85fd73e59050f36/src/write.jl#L78-L110";>source</a></section></article><article
class="docstring"><header><a class="docstring-article-toggle-button fa-solid
fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a
class="docstring-binding" id="Arrow.append"
href="#Arrow.append"><code>Arrow.append</code></a> — <span class="docstring-
[...]
+ end</code></pre></div><a class="docs-sourcelink" target="_blank"
href="https://github.com/apache/arrow-julia/blob/2696105d01cfda7c55d1902951a20908a3c205e5/src/write.jl#L78-L110";>source</a></section></article><article
class="docstring"><header><a class="docstring-article-toggle-button fa-solid
fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a
class="docstring-binding" id="Arrow.append"
href="#Arrow.append"><code>Arrow.append</code></a> — <span class="docstring-
[...]
Arrow.append(file::String, tbl)
-tbl |> Arrow.append(file)</code></pre><p>Append any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> to an existing arrow formatted file or IO. The existing arrow
data must be in IPC stream format. Note that appending to the "feather
formatted file" is <em>not</em> allowed, as this file format doesn't
support appending. That means files written like
<code>Arrow.write(filename::String, tbl)</code> <em>cannot</em> be appended to;
i [...]
+tbl |> Arrow.append(file)</code></pre><p>Append any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> to an existing arrow formatted file or IO. The existing arrow
data must be in IPC stream format. Note that appending to the "feather
formatted file" is <em>not</em> allowed, as this file format doesn't
support appending. That means files written like
<code>Arrow.write(filename::String, tbl)</code> <em>cannot</em> be appended to;
i [...]
Arrow.write(file::String, tbl)
-tbl |> Arrow.write(io_or_file)</code></pre><p>Write any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> out as arrow formatted data. Providing an <code>io::IO</code>
argument will cause the data to be written to it in the <a
href="https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format";>"streaming"
format</a>, unless <code>file=true</code> keyword argument is passed.
Providing a <code>file::String</code> argument wil [...]
+tbl |> Arrow.write(io_or_file)</code></pre><p>Write any <a
href="https://github.com/JuliaData/Tables.jl";>Tables.jl</a>-compatible
<code>tbl</code> out as arrow formatted data. Providing an <code>io::IO</code>
argument will cause the data to be written to it in the <a
href="https://arrow.apache.org/docs/format/Columnar.html#ipc-streaming-format";>"streaming"
format</a>, unless <code>file=true</code> keyword argument is passed.
Providing a <code>file::String</code> argument wil [...]
