arrow-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From u..@apache.org
Subject [03/19] arrow-site git commit: API doc update
Date Sun, 19 Nov 2017 14:56:16 GMT
http://git-wip-us.apache.org/repos/asf/arrow-site/blob/35611f84/docs/python/memory.html
----------------------------------------------------------------------
diff --git a/docs/python/memory.html b/docs/python/memory.html
index 143842c..7c4747d 100644
--- a/docs/python/memory.html
+++ b/docs/python/memory.html
@@ -155,7 +155,7 @@ management and IO systems:</p>
 </ul>
 <div class="section" id="pyarrow-buffer">
 <h2>pyarrow.Buffer<a class="headerlink" href="#pyarrow-buffer" title="Permalink
to this headline">¶</a></h2>
-<p>The <code class="xref py py-class docutils literal"><span class="pre">Buffer</span></code>
object wraps the C++ <code class="docutils literal"><span class="pre">arrow::Buffer</span></code>
type and is
+<p>The <a class="reference internal" href="generated/pyarrow.Buffer.html#pyarrow.Buffer"
title="pyarrow.Buffer"><code class="xref py py-class docutils literal"><span class="pre">Buffer</span></code></a>
object wraps the C++ <code class="docutils literal"><span class="pre">arrow::Buffer</span></code>
type and is
 the primary tool for memory management in Apache Arrow in C++. It permits
 higher-level array classes to safely interact with memory which they may or may
 not own. <code class="docutils literal"><span class="pre">arrow::Buffer</span></code>
can be zero-copy sliced to permit Buffers to cheaply
@@ -164,71 +164,32 @@ parent-child relationships.</p>
 <p>There are many implementations of <code class="docutils literal"><span
class="pre">arrow::Buffer</span></code>, but they all provide a
 standard interface: a data pointer and length. This is similar to Python’s
 built-in <cite>buffer protocol</cite> and <code class="docutils literal"><span
class="pre">memoryview</span></code> objects.</p>
-<p>A <code class="xref py py-class docutils literal"><span class="pre">Buffer</span></code>
can be created from any Python object which
+<p>A <a class="reference internal" href="generated/pyarrow.Buffer.html#pyarrow.Buffer"
title="pyarrow.Buffer"><code class="xref py py-class docutils literal"><span class="pre">Buffer</span></code></a>
can be created from any Python object which
 implements the buffer protocol. Let’s consider a bytes object:</p>
 <div class="highlight-ipython"><div class="highlight"><pre><span></span><span
class="gp">In [1]: </span><span class="kn">import</span> <span class="nn">pyarrow</span>
<span class="kn">as</span> <span class="nn">pa</span>
-<span class="gt">---------------------------------------------------------------------------</span>
-<span class="ne">ImportError</span><span class="g g-Whitespace">      
                        </span>Traceback (most recent call last)
-<span class="nn">&lt;ipython-input-1-852643f3aad4&gt;</span> in <span
class="ni">&lt;module&gt;</span><span class="nt">()</span>
-<span class="ne">----&gt; </span><span class="mi">1</span> <span
class="kn">import</span> <span class="nn">pyarrow</span> <span class="kn">as</span>
<span class="nn">pa</span>
-
-<span class="nn">~apache-arrow/arrow/python/pyarrow/__init__.py</span> in <span
class="ni">&lt;module&gt;</span><span class="nt">()</span>
-<span class="g g-Whitespace">     </span><span class="mi">30</span>

-<span class="g g-Whitespace">     </span><span class="mi">31</span>

-<span class="ne">---&gt; </span><span class="mi">32</span> <span
class="kn">from</span> <span class="nn">pyarrow.lib</span> <span class="kn">import</span>
<span class="n">cpu_count</span><span class="p">,</span> <span
class="n">set_cpu_count</span>
-<span class="g g-Whitespace">     </span><span class="mi">33</span>
<span class="kn">from</span> <span class="nn">pyarrow.lib</span> <span
class="kn">import</span> <span class="p">(</span><span class="n">null</span><span
class="p">,</span> <span class="n">bool_</span><span class="p">,</span>
-<span class="g g-Whitespace">     </span><span class="mi">34</span>
                         <span class="n">int8</span><span class="p">,</span>
<span class="n">int16</span><span class="p">,</span> <span class="n">int32</span><span
class="p">,</span> <span class="n">int64</span><span class="p">,</span>
-
-<span class="ne">ImportError</span>: libarrow.so.0: cannot open shared object
file: No such file or directory
 
 <span class="gp">In [2]: </span><span class="n">data</span> <span
class="o">=</span> <span class="sa">b</span><span class="s1">&#39;abcdefghijklmnopqrstuvwxyz&#39;</span>
 
 <span class="gp">In [3]: </span><span class="n">buf</span> <span
class="o">=</span> <span class="n">pa</span><span class="o">.</span><span
class="n">frombuffer</span><span class="p">(</span><span class="n">data</span><span
class="p">)</span>
-<span class="gt">---------------------------------------------------------------------------</span>
-<span class="ne">NameError</span><span class="g g-Whitespace">        
                        </span>Traceback (most recent call last)
-<span class="nn">&lt;ipython-input-3-0ec9d631567d&gt;</span> in <span
class="ni">&lt;module&gt;</span><span class="nt">()</span>
-<span class="ne">----&gt; </span><span class="mi">1</span> <span
class="n">buf</span> <span class="o">=</span> <span class="n">pa</span><span
class="o">.</span><span class="n">frombuffer</span><span class="p">(</span><span
class="n">data</span><span class="p">)</span>
-
-<span class="ne">NameError</span>: name &#39;pa&#39; is not defined
 
 <span class="gp">In [4]: </span><span class="n">buf</span>
-<span class="go">
Mime
View raw message