<p dir="auto">Some public functions defined in <code class="notranslate">numpy/core/records.py</code> and accessible via the <code class="notranslate">np.rec</code> namespace have incomplete docstrings that do not fully comply with the <a href="https://numpydoc.readthedocs.io/en/latest/format.html" rel="nofollow">numpydoc standard</a>.</p>
<p dir="auto">For example:</p>
<p dir="auto"></p><div class="Box Box--condensed my-2">
  <div class="Box-header f6">
    <p class="mb-0 text-bold">
      <a href="https://github.com/numpy/numpy/blob/43ca3a5bd882dc69bca0fa777113e6821c9f44e0/numpy/core/records.py#L596-L609">numpy/numpy/core/records.py</a>
    </p>
    <p class="mb-0 color-fg-muted">
        Lines 596 to 609
      in
      <a data-pjax="true" class="commit-tease-sha" href="/numpy/numpy/commit/43ca3a5bd882dc69bca0fa777113e6821c9f44e0">43ca3a5</a>
    </p>
  </div>
  <div itemprop="text" class="Box-body p-0 blob-wrapper blob-wrapper-embedded data">
    <table class="highlight tab-size mb-0 js-file-line-container" data-tab-size="8" data-paste-markdown-skip="">

        <tbody><tr class="border-0">
          <td id="L596" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="596"></td>
          <td id="LC596" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-k">def</span> <span class="pl-en">fromarrays</span>(<span class="pl-s1">arrayList</span>, <span class="pl-s1">dtype</span><span class="pl-c1">=</span><span class="pl-c1">None</span>, <span class="pl-s1">shape</span><span class="pl-c1">=</span><span class="pl-c1">None</span>, <span class="pl-s1">formats</span><span class="pl-c1">=</span><span class="pl-c1">None</span>, </td>
        </tr>

        <tr class="border-0">
          <td id="L597" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="597"></td>
          <td id="LC597" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line">                <span class="pl-s1">names</span><span class="pl-c1">=</span><span class="pl-c1">None</span>, <span class="pl-s1">titles</span><span class="pl-c1">=</span><span class="pl-c1">None</span>, <span class="pl-s1">aligned</span><span class="pl-c1">=</span><span class="pl-c1">False</span>, <span class="pl-s1">byteorder</span><span class="pl-c1">=</span><span class="pl-c1">None</span>): </td>
        </tr>

        <tr class="border-0">
          <td id="L598" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="598"></td>
          <td id="LC598" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line">     <span class="pl-s">""" create a record array from a (flat) list of arrays</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L599" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="599"></td>
          <td id="LC599" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s"></span> </td>
        </tr>

        <tr class="border-0">
          <td id="L600" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="600"></td>
          <td id="LC600" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    &gt;&gt;&gt; x1=np.array([1,2,3,4])</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L601" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="601"></td>
          <td id="LC601" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    &gt;&gt;&gt; x2=np.array(['a','dd','xyz','12'])</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L602" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="602"></td>
          <td id="LC602" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    &gt;&gt;&gt; x3=np.array([1.1,2,3,4])</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L603" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="603"></td>
          <td id="LC603" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    &gt;&gt;&gt; r = np.core.records.fromarrays([x1,x2,x3],names='a,b,c')</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L604" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="604"></td>
          <td id="LC604" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    &gt;&gt;&gt; print(r[1])</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L605" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="605"></td>
          <td id="LC605" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    (2, 'dd', 2.0) # may vary</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L606" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="606"></td>
          <td id="LC606" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    &gt;&gt;&gt; x1[1]=34</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L607" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="607"></td>
          <td id="LC607" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    &gt;&gt;&gt; r.a</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L608" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="608"></td>
          <td id="LC608" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    array([1, 2, 3, 4])</span> </td>
        </tr>

        <tr class="border-0">
          <td id="L609" class="blob-num border-0 px-3 py-0 color-bg-default" data-line-number="609"></td>
          <td id="LC609" class="blob-code border-0 px-3 py-0 color-bg-default blob-code-inner js-file-line"> <span class="pl-s">    """</span> </td>
        </tr>
    </tbody></table>
  </div>
</div>
<p></p>
<p dir="auto">At the very least, this docstring is missing the <code class="notranslate">Parameters</code> and <code class="notranslate">Returns</code> sections as well as the <code class="notranslate">Examples</code> header above the examples.</p>
<p dir="auto">A listing of functions that this issue applies to in <code class="notranslate">numpy/core/records.py</code></p>
<ul dir="auto">
<li><code class="notranslate">fromarrays</code></li>
<li><code class="notranslate">fromrecords</code></li>
<li><code class="notranslate">fromstring</code></li>
<li><code class="notranslate">fromfile</code></li>
<li><code class="notranslate">array</code></li>
</ul>
<p dir="auto">Additionally (perhaps a separate issue), there are two other functions which are "public" (i.e. name does not start with an underscore) though from context it appears that they may be intended only for internal use within the <code class="notranslate">records</code> submodule. They also do not have proper docstrings:</p>
<ul dir="auto">
<li><code class="notranslate">find_duplicate</code></li>
<li><code class="notranslate">get_remaining_size</code></li>
</ul>
<h3 dir="auto">Numpy/Python version information:</h3>
<p dir="auto">1.19.0.dev0+0b9b176 3.8.2 (default, Feb 26 2020, 22:21:03)</p>
<p dir="auto"><a target="_blank" rel="noopener noreferrer nofollow" href="https://user-images.githubusercontent.com/31265128/38846412-2fa2cf4a-41ca-11e8-91b7-0157b1a44d1e.png"><img width="847" alt="screen shot 2018-04-16 at 11 01 46 pm" src="https://user-images.githubusercontent.com/31265128/38846412-2fa2cf4a-41ca-11e8-91b7-0157b1a44d1e.png" style="max-width: 100%;"></a></p>