This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 498f461 update documentation for tag main
498f461 is described below
commit 498f461956ace1fe200b5c3576c34643b6cb065f
Author: GitHub Actions <[email protected]>
AuthorDate: Thu Sep 21 21:08:29 2023 +0000
update documentation for tag main
---
main/r/pkgdown.yml | 2 +-
main/reference/c.html | 6 +++---
main/searchindex.js | 2 +-
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index 364fca1..8c931c5 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-09-21T21:07Z
+last_built: 2023-09-21T21:08Z
diff --git a/main/reference/c.html b/main/reference/c.html
index 7d1a4a0..43713d7 100644
--- a/main/reference/c.html
+++ b/main/reference/c.html
@@ -762,14 +762,14 @@ document.write(`
<dt class="sig sig-object cpp"
id="_CPPv421ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView">
<span
id="_CPPv321ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView"></span><span
id="_CPPv221ArrowArrayAppendBytesP10ArrowArray15ArrowBufferView"></span><span
id="ArrowArrayAppendBytes__ArrowArrayP.ArrowBufferView"></span><span
class="target"
id="group__nanoarrow-array_1ga40e1dce8b43124c9710538842e68f944"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference [...]
<dd><p>Append a string of bytes to an array. </p>
-<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type or EINVAL otherwise (e.g., the underlying array is not a binary,
string, large binary, large string, or fixed-size binary array, or value is the
wrong size for a fixed-size binary array). </p>
+<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type, EOVERFLOW if appending value would overflow the offset type
(e.g., if the data buffer would be larger than 2 GB for a non-large string
type), or EINVAL otherwise (e.g., the underlying array is not a binary, string,
large binary, large string, or fixed-size binary array, or value is the wrong
size for a fixed-size binary array). </p>
</dd></dl>
<dl class="cpp function">
<dt class="sig sig-object cpp"
id="_CPPv422ArrowArrayAppendStringP10ArrowArray15ArrowStringView">
<span
id="_CPPv322ArrowArrayAppendStringP10ArrowArray15ArrowStringView"></span><span
id="_CPPv222ArrowArrayAppendStringP10ArrowArray15ArrowStringView"></span><span
id="ArrowArrayAppendString__ArrowArrayP.ArrowStringView"></span><span
class="target"
id="group__nanoarrow-array_1gaa8c9118312eda7fc17fb6bf9d721ca9d"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="refere [...]
<dd><p>Append a string value to an array. </p>
-<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type or EINVAL otherwise (e.g., the underlying array is not a string or
large string array). </p>
+<p>Returns NANOARROW_OK if value can be exactly represented by the underlying
storage type, EOVERFLOW if appending value would overflow the offset type
(e.g., if the data buffer would be larger than 2 GB for a non-large string
type), or EINVAL otherwise (e.g., the underlying array is not a string or large
string array). </p>
</dd></dl>
<dl class="cpp function">
@@ -790,7 +790,7 @@ document.write(`
<dt class="sig sig-object cpp"
id="_CPPv423ArrowArrayFinishElementP10ArrowArray">
<span id="_CPPv323ArrowArrayFinishElementP10ArrowArray"></span><span
id="_CPPv223ArrowArrayFinishElementP10ArrowArray"></span><span
id="ArrowArrayFinishElement__ArrowArrayP"></span><span class="target"
id="group__nanoarrow-array_1ga357c8828c0ae590c5ae26eac22cce485"></span><span
class="k"><span class="pre">static</span></span><span class="w"> </span><span
class="k"><span class="pre">inline</span></span><span class="w"> </span><a
class="reference internal" href="#_CPPv414ArrowErrorCode" ti [...]
<dd><p>Finish a nested array element. </p>
-<p>Appends a non-null element to the array based on the first child’s current
length. Returns NANOARROW_OK if the item was successfully added or EINVAL if
the underlying storage type is not a struct, list, large list, or fixed-size
list, or if there was an attempt to add a struct or fixed-size list element
where the length of the child array(s) did not match the expected length. </p>
+<p>Appends a non-null element to the array based on the first child’s current
length. Returns NANOARROW_OK if the item was successfully added, EOVERFLOW if
the child of a list or map array would exceed INT_MAX elements, or EINVAL if
the underlying storage type is not a struct, list, large list, or fixed-size
list, or if there was an attempt to add a struct or fixed-size list element
where the length of the child array(s) did not match the expected length. </p>
</dd></dl>
<dl class="cpp function">
diff --git a/main/searchindex.js b/main/searchindex.js
index 808f573..ef4492a 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["getting-started", "index", "reference/c",
"reference/cpp", "reference/device", "reference/index", "reference/ipc",
"reference/r", "roadmap"], "filenames": ["getting-started.rst", "index.rst",
"reference/c.rst", "reference/cpp.rst", "reference/device.rst",
"reference/index.rst", "reference/ipc.rst", "reference/r.rst", "roadmap.rst"],
"titles": ["Getting started with nanoarrow", "nanoarrow", "C API Reference",
"C++ API Reference", "Device Extension Reference" [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["getting-started", "index", "reference/c",
"reference/cpp", "reference/device", "reference/index", "reference/ipc",
"reference/r", "roadmap"], "filenames": ["getting-started.rst", "index.rst",
"reference/c.rst", "reference/cpp.rst", "reference/device.rst",
"reference/index.rst", "reference/ipc.rst", "reference/r.rst", "roadmap.rst"],
"titles": ["Getting started with nanoarrow", "nanoarrow", "C API Reference",
"C++ API Reference", "Device Extension Reference" [...]
\ No newline at end of file
