This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/arrow-nanoarrow.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new a4f8059 update documentation for tag dev
a4f8059 is described below
commit a4f8059ff4f65db014a961ce4e175051d12a7781
Author: GitHub Actions <[email protected]>
AuthorDate: Thu Jul 13 12:41:53 2023 +0000
update documentation for tag dev
---
dev/_sources/getting-started_generated.rst.txt | 25 +++++++++++++-----------
dev/getting-started.html | 27 +++++++++++++++-----------
dev/getting-started_generated.html | 27 +++++++++++++++-----------
dev/r/pkgdown.yml | 2 +-
dev/searchindex.js | 2 +-
5 files changed, 48 insertions(+), 35 deletions(-)
diff --git a/dev/_sources/getting-started_generated.rst.txt
b/dev/_sources/getting-started_generated.rst.txt
index 6a266ec..743b752 100644
--- a/dev/_sources/getting-started_generated.rst.txt
+++ b/dev/_sources/getting-started_generated.rst.txt
@@ -232,7 +232,7 @@ return ``int`` and/or an ``ArrowError*`` argument. This
usually means
that there is an outer function that presents a more idiomatic interface
(e.g., returning ``std::optional<>`` or throwing an exception) and an
inner function that uses nanoarrow-style error handling. Embracing
-``NANOARROW_RETURN_NOT_OK()`` is key to hapiness when using the
+``NANOARROW_RETURN_NOT_OK()`` is key to happiness when using the
nanoarrow library.
Third, let’s discuss memory management. Because nanoarrow is implemented
@@ -312,8 +312,8 @@ integration.
FetchContent_Declare(
nanoarrow
- URL
https://github.com/apache/arrow-nanoarrow/releases/download/apache-arrow-nanoarrow-0.1.0/apache-arrow-nanoarrow-0.1.0.tar.gz
- URL_HASH
SHA512=dc62480b986ee76aaad8e38c6fbc602f8cef2cc35a5f5ede7da2a93b4db2b63839bdca3eefe8a44ae1cb6895a2fd3f090e3f6ea1020cf93cfe86437304dfee17)
+ URL
https://github.com/apache/arrow-nanoarrow/releases/download/apache-arrow-nanoarrow-0.2.0/apache-arrow-nanoarrow-0.2.0.tar.gz
+ URL_HASH
SHA512=38a100ae5c36a33aa330010eb27b051cff98671e9c82fff22b1692bb77ae61bd6dc2a52ac6922c6c8657bd4c79a059ab26e8413de8169eeed3c9b7fdb216c817)
FetchContent_MakeAvailable(nanoarrow)
add_library(linesplitter linesplitter.cc)
@@ -334,10 +334,11 @@ indicating progress towards building and linking
``linesplitter``.
Building an ArrowArray
----------------------
-The input for our ``linesplitter_read()`` function in an
+The input for our ``linesplitter_read()`` function is an
``std::string``, which we’ll iterate over and add each detected line as
-its own element. First, some core logic to detect the number of
-characters until the next ``\n`` or end-of-string.
+its own element. First, we’ll define a function for the core logic of
+detecting the number of characters until the next ``\n`` or
+end-of-string.
.. code:: cpp
@@ -484,11 +485,13 @@ Then, add the following to your ``CMakeLists.txt``:
include(GoogleTest)
gtest_discover_tests(linesplitter_test)
-After you’re done, build the project again using the **CMake: Build**
-command from the command palette. If all goes well, choose **Test: Run
-All Tests** from the command pallete to run them! You should see some
-output indiciating that tests ran successfully, or you can use VSCode’s
-“Testing” panel to visually inspect which tests passed.
+| After you’re done, build the project again using the **CMake: Build**
+ command from the command palette. If all goes well, choose **CMake:
+ Refresh Tests** and then
+| **Test: Run All Tests** from the command pallete to run them! You
+ should see some output indiciating that tests ran successfully, or you
+ can use VSCode’s “Testing” panel to visually inspect which tests
+ passed.
.. note::
If you're not using VSCode, you can accomplish the equivalent task in in a
terminal
diff --git a/dev/getting-started.html b/dev/getting-started.html
index e2affaf..8e5d361 100644
--- a/dev/getting-started.html
+++ b/dev/getting-started.html
@@ -533,7 +533,7 @@ return <code class="docutils literal notranslate"><span
class="pre">int</span></
that there is an outer function that presents a more idiomatic interface
(e.g., returning <code class="docutils literal notranslate"><span
class="pre">std::optional<></span></code> or throwing an exception) and an
inner function that uses nanoarrow-style error handling. Embracing
-<code class="docutils literal notranslate"><span
class="pre">NANOARROW_RETURN_NOT_OK()</span></code> is key to hapiness when
using the
+<code class="docutils literal notranslate"><span
class="pre">NANOARROW_RETURN_NOT_OK()</span></code> is key to happiness when
using the
nanoarrow library.</p>
<p>Third, let’s discuss memory management. Because nanoarrow is implemented
in C and provides a C interface, the library by default uses C-style
@@ -603,8 +603,8 @@ integration.</p>
<span class="nb">FetchContent_Declare</span><span class="p">(</span>
<span class="w"> </span><span class="s">nanoarrow</span>
-<span class="w"> </span><span class="s">URL</span><span class="w">
</span><span
class="s">https://github.com/apache/arrow-nanoarrow/releases/download/apache-arrow-nanoarrow-0.1.0/apache-arrow-nanoarrow-0.1.0.tar.gz</span>
-<span class="w"> </span><span class="s">URL_HASH</span><span class="w">
</span><span
class="s">SHA512=dc62480b986ee76aaad8e38c6fbc602f8cef2cc35a5f5ede7da2a93b4db2b63839bdca3eefe8a44ae1cb6895a2fd3f090e3f6ea1020cf93cfe86437304dfee17</span><span
class="p">)</span>
+<span class="w"> </span><span class="s">URL</span><span class="w">
</span><span
class="s">https://github.com/apache/arrow-nanoarrow/releases/download/apache-arrow-nanoarrow-0.2.0/apache-arrow-nanoarrow-0.2.0.tar.gz</span>
+<span class="w"> </span><span class="s">URL_HASH</span><span class="w">
</span><span
class="s">SHA512=38a100ae5c36a33aa330010eb27b051cff98671e9c82fff22b1692bb77ae61bd6dc2a52ac6922c6c8657bd4c79a059ab26e8413de8169eeed3c9b7fdb216c817</span><span
class="p">)</span>
<span class="nb">FetchContent_MakeAvailable</span><span
class="p">(</span><span class="s">nanoarrow</span><span class="p">)</span>
<span class="nb">add_library</span><span class="p">(</span><span
class="s">linesplitter</span><span class="w"> </span><span
class="s">linesplitter.cc</span><span class="p">)</span>
@@ -629,10 +629,11 @@ with <code class="docutils literal notranslate"><span
class="pre">mkdir</span> <
</section>
<section id="building-an-arrowarray">
<h2>Building an ArrowArray<a class="headerlink" href="#building-an-arrowarray"
title="Permalink to this heading">#</a></h2>
-<p>The input for our <code class="docutils literal notranslate"><span
class="pre">linesplitter_read()</span></code> function in an
+<p>The input for our <code class="docutils literal notranslate"><span
class="pre">linesplitter_read()</span></code> function is an
<code class="docutils literal notranslate"><span
class="pre">std::string</span></code>, which we’ll iterate over and add each
detected line as
-its own element. First, some core logic to detect the number of
-characters until the next <code class="docutils literal notranslate"><span
class="pre">\n</span></code> or end-of-string.</p>
+its own element. First, we’ll define a function for the core logic of
+detecting the number of characters until the next <code class="docutils
literal notranslate"><span class="pre">\n</span></code> or
+end-of-string.</p>
<div class="highlight-cpp notranslate"><div
class="highlight"><pre><span></span><span class="k">static</span><span
class="w"> </span><span class="kt">int64_t</span><span class="w"> </span><span
class="nf">find_newline</span><span class="p">(</span><span
class="k">const</span><span class="w"> </span><span
class="n">ArrowStringView</span><span class="o">&</span><span class="w">
</span><span class="n">src</span><span class="p">)</span><span class="w">
</span><span class="p">{</span>
<span class="w"> </span><span class="k">for</span><span class="w">
</span><span class="p">(</span><span class="kt">int64_t</span><span class="w">
</span><span class="n">i</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="mi">0</span><span
class="p">;</span><span class="w"> </span><span class="n">i</span><span
class="w"> </span><span class="o"><</span><span class="w"> </span><span
class="n">src</span><span class="p">.</span><span class="n">size [...]
<span class="w"> </span><span class="k">if</span><span class="w">
</span><span class="p">(</span><span class="n">src</span><span
class="p">.</span><span class="n">data</span><span class="p">[</span><span
class="n">i</span><span class="p">]</span><span class="w"> </span><span
class="o">==</span><span class="w"> </span><span
class="sc">'\n'</span><span class="p">)</span><span class="w">
</span><span class="p">{</span>
@@ -764,11 +765,15 @@ the complexity of your project grows.</p>
<span class="nb">gtest_discover_tests</span><span class="p">(</span><span
class="s">linesplitter_test</span><span class="p">)</span>
</pre></div>
</div>
-<p>After you’re done, build the project again using the <strong>CMake:
Build</strong>
-command from the command palette. If all goes well, choose <strong>Test: Run
-All Tests</strong> from the command pallete to run them! You should see some
-output indiciating that tests ran successfully, or you can use VSCode’s
-“Testing” panel to visually inspect which tests passed.</p>
+<div class="line-block">
+<div class="line">After you’re done, build the project again using the
<strong>CMake: Build</strong>
+command from the command palette. If all goes well, choose <strong>CMake:
+Refresh Tests</strong> and then</div>
+<div class="line"><strong>Test: Run All Tests</strong> from the command
pallete to run them! You
+should see some output indiciating that tests ran successfully, or you
+can use VSCode’s “Testing” panel to visually inspect which tests
+passed.</div>
+</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you’re not using VSCode, you can accomplish the equivalent task in in a
terminal
diff --git a/dev/getting-started_generated.html
b/dev/getting-started_generated.html
index 82dc23c..2d7f0d1 100644
--- a/dev/getting-started_generated.html
+++ b/dev/getting-started_generated.html
@@ -531,7 +531,7 @@ return <code class="docutils literal notranslate"><span
class="pre">int</span></
that there is an outer function that presents a more idiomatic interface
(e.g., returning <code class="docutils literal notranslate"><span
class="pre">std::optional<></span></code> or throwing an exception) and an
inner function that uses nanoarrow-style error handling. Embracing
-<code class="docutils literal notranslate"><span
class="pre">NANOARROW_RETURN_NOT_OK()</span></code> is key to hapiness when
using the
+<code class="docutils literal notranslate"><span
class="pre">NANOARROW_RETURN_NOT_OK()</span></code> is key to happiness when
using the
nanoarrow library.</p>
<p>Third, let’s discuss memory management. Because nanoarrow is implemented
in C and provides a C interface, the library by default uses C-style
@@ -601,8 +601,8 @@ integration.</p>
<span class="nb">FetchContent_Declare</span><span class="p">(</span>
<span class="w"> </span><span class="s">nanoarrow</span>
-<span class="w"> </span><span class="s">URL</span><span class="w">
</span><span
class="s">https://github.com/apache/arrow-nanoarrow/releases/download/apache-arrow-nanoarrow-0.1.0/apache-arrow-nanoarrow-0.1.0.tar.gz</span>
-<span class="w"> </span><span class="s">URL_HASH</span><span class="w">
</span><span
class="s">SHA512=dc62480b986ee76aaad8e38c6fbc602f8cef2cc35a5f5ede7da2a93b4db2b63839bdca3eefe8a44ae1cb6895a2fd3f090e3f6ea1020cf93cfe86437304dfee17</span><span
class="p">)</span>
+<span class="w"> </span><span class="s">URL</span><span class="w">
</span><span
class="s">https://github.com/apache/arrow-nanoarrow/releases/download/apache-arrow-nanoarrow-0.2.0/apache-arrow-nanoarrow-0.2.0.tar.gz</span>
+<span class="w"> </span><span class="s">URL_HASH</span><span class="w">
</span><span
class="s">SHA512=38a100ae5c36a33aa330010eb27b051cff98671e9c82fff22b1692bb77ae61bd6dc2a52ac6922c6c8657bd4c79a059ab26e8413de8169eeed3c9b7fdb216c817</span><span
class="p">)</span>
<span class="nb">FetchContent_MakeAvailable</span><span
class="p">(</span><span class="s">nanoarrow</span><span class="p">)</span>
<span class="nb">add_library</span><span class="p">(</span><span
class="s">linesplitter</span><span class="w"> </span><span
class="s">linesplitter.cc</span><span class="p">)</span>
@@ -627,10 +627,11 @@ with <code class="docutils literal notranslate"><span
class="pre">mkdir</span> <
</section>
<section id="building-an-arrowarray">
<h2>Building an ArrowArray<a class="headerlink" href="#building-an-arrowarray"
title="Permalink to this heading">#</a></h2>
-<p>The input for our <code class="docutils literal notranslate"><span
class="pre">linesplitter_read()</span></code> function in an
+<p>The input for our <code class="docutils literal notranslate"><span
class="pre">linesplitter_read()</span></code> function is an
<code class="docutils literal notranslate"><span
class="pre">std::string</span></code>, which we’ll iterate over and add each
detected line as
-its own element. First, some core logic to detect the number of
-characters until the next <code class="docutils literal notranslate"><span
class="pre">\n</span></code> or end-of-string.</p>
+its own element. First, we’ll define a function for the core logic of
+detecting the number of characters until the next <code class="docutils
literal notranslate"><span class="pre">\n</span></code> or
+end-of-string.</p>
<div class="highlight-cpp notranslate"><div
class="highlight"><pre><span></span><span class="k">static</span><span
class="w"> </span><span class="kt">int64_t</span><span class="w"> </span><span
class="nf">find_newline</span><span class="p">(</span><span
class="k">const</span><span class="w"> </span><span
class="n">ArrowStringView</span><span class="o">&</span><span class="w">
</span><span class="n">src</span><span class="p">)</span><span class="w">
</span><span class="p">{</span>
<span class="w"> </span><span class="k">for</span><span class="w">
</span><span class="p">(</span><span class="kt">int64_t</span><span class="w">
</span><span class="n">i</span><span class="w"> </span><span
class="o">=</span><span class="w"> </span><span class="mi">0</span><span
class="p">;</span><span class="w"> </span><span class="n">i</span><span
class="w"> </span><span class="o"><</span><span class="w"> </span><span
class="n">src</span><span class="p">.</span><span class="n">size [...]
<span class="w"> </span><span class="k">if</span><span class="w">
</span><span class="p">(</span><span class="n">src</span><span
class="p">.</span><span class="n">data</span><span class="p">[</span><span
class="n">i</span><span class="p">]</span><span class="w"> </span><span
class="o">==</span><span class="w"> </span><span
class="sc">'\n'</span><span class="p">)</span><span class="w">
</span><span class="p">{</span>
@@ -762,11 +763,15 @@ the complexity of your project grows.</p>
<span class="nb">gtest_discover_tests</span><span class="p">(</span><span
class="s">linesplitter_test</span><span class="p">)</span>
</pre></div>
</div>
-<p>After you’re done, build the project again using the <strong>CMake:
Build</strong>
-command from the command palette. If all goes well, choose <strong>Test: Run
-All Tests</strong> from the command pallete to run them! You should see some
-output indiciating that tests ran successfully, or you can use VSCode’s
-“Testing” panel to visually inspect which tests passed.</p>
+<div class="line-block">
+<div class="line">After you’re done, build the project again using the
<strong>CMake: Build</strong>
+command from the command palette. If all goes well, choose <strong>CMake:
+Refresh Tests</strong> and then</div>
+<div class="line"><strong>Test: Run All Tests</strong> from the command
pallete to run them! You
+should see some output indiciating that tests ran successfully, or you
+can use VSCode’s “Testing” panel to visually inspect which tests
+passed.</div>
+</div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you’re not using VSCode, you can accomplish the equivalent task in in a
terminal
diff --git a/dev/r/pkgdown.yml b/dev/r/pkgdown.yml
index cea2b5a..67d2c5c 100644
--- a/dev/r/pkgdown.yml
+++ b/dev/r/pkgdown.yml
@@ -2,5 +2,5 @@ pandoc: 2.9.2.1
pkgdown: 2.0.7
pkgdown_sha: ~
articles: {}
-last_built: 2023-07-07T13:14Z
+last_built: 2023-07-13T12:41Z
diff --git a/dev/searchindex.js b/dev/searchindex.js
index fe13cb4..f4be07b 100644
--- a/dev/searchindex.js
+++ b/dev/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"docnames": ["getting-started", "getting-started_generated",
"index", "reference/c", "reference/cpp", "reference/device", "reference/index",
"reference/ipc", "reference/r"], "filenames": ["getting-started.rst",
"getting-started_generated.rst", "index.rst", "reference/c.rst",
"reference/cpp.rst", "reference/device.rst", "reference/index.rst",
"reference/ipc.rst", "reference/r.rst"], "titles": ["Getting started with
nanoarrow", "Getting started with nanoarrow", "nanoarrow" [...]
\ No newline at end of file
+Search.setIndex({"docnames": ["getting-started", "getting-started_generated",
"index", "reference/c", "reference/cpp", "reference/device", "reference/index",
"reference/ipc", "reference/r"], "filenames": ["getting-started.rst",
"getting-started_generated.rst", "index.rst", "reference/c.rst",
"reference/cpp.rst", "reference/device.rst", "reference/index.rst",
"reference/ipc.rst", "reference/r.rst"], "titles": ["Getting started with
nanoarrow", "Getting started with nanoarrow", "nanoarrow" [...]
\ No newline at end of file
