Skip to content

Commit

Permalink
Merge pull request #1353 from RandallPittmanOrSt/rc_getset_docsupdate
Browse files Browse the repository at this point in the history
[docs] Add link to auth page on rc files.
  • Loading branch information
jswhit committed Jul 31, 2024
2 parents 7c61f6e + 9996c01 commit 6b4b44c
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1173,7 +1173,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<span>def <span class="ident">date2index</span></span>(<span>dates, nctime, calendar=None, select='exact', has_year_zero=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Return indices of a netCDF time variable corresponding to the given dates.</p>
<div class="desc"><p>date2index(dates, nctime, calendar=None, select=u'exact', has_year_zero=None)</p>
<p>Return indices of a netCDF time variable corresponding to the given dates.</p>
<p><strong>dates</strong>: A datetime object or a sequence of datetime objects.
The datetime objects should not include a time-zone offset.</p>
<p><strong>nctime</strong>: A netCDF time variable object. The nctime object must have a
Expand Down Expand Up @@ -1212,7 +1213,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<span>def <span class="ident">date2num</span></span>(<span>dates, units, calendar=None, has_year_zero=None, longdouble=False)</span>
</code></dt>
<dd>
<div class="desc"><p>Return numeric time values given datetime objects. The units
<div class="desc"><p>date2num(dates, units, calendar=None, has_year_zero=None, longdouble=False)</p>
<p>Return numeric time values given datetime objects. The units
of the numeric time values are described by the <strong>units</strong> argument
and the <strong>calendar</strong> keyword. The datetime objects must
be in UTC with no time-zone offset.
Expand Down Expand Up @@ -1292,7 +1294,8 @@ <h2 class="section-title" id="header-functions">Functions</h2>
<span>def <span class="ident">num2date</span></span>(<span>times, units, calendar='standard', only_use_cftime_datetimes=True, only_use_python_datetimes=False, has_year_zero=None)</span>
</code></dt>
<dd>
<div class="desc"><p>Return datetime objects given numeric time values. The units
<div class="desc"><p>num2date(times, units, calendar=u'standard', only_use_cftime_datetimes=True, only_use_python_datetimes=False, has_year_zero=None)</p>
<p>Return datetime objects given numeric time values. The units
of the numeric time values are described by the <strong>units</strong> argument
and the <strong>calendar</strong> keyword. The returned datetime objects represent
UTC with no time-zone offset, even if the specified
Expand Down Expand Up @@ -1348,14 +1351,18 @@ <h2 class="section-title" id="header-functions">Functions</h2>
</code></dt>
<dd>
<div class="desc"><p><strong><code>rc_get(key)</code></strong></p>
<p>Returns the internal netcdf-c rc table value corresponding to key.</p></div>
<p>Returns the internal netcdf-c rc table value corresponding to key.
See <a href="https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html">https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html</a>
for more information on rc files and values.</p></div>
</dd>
<dt id="netCDF4.rc_set"><code class="name flex">
<span>def <span class="ident">rc_set</span></span>(<span>key, value)</span>
</code></dt>
<dd>
<div class="desc"><p><strong><code>rc_set(key, value)</code></strong></p>
<p>Sets the internal netcdf-c rc table value corresponding to key.</p></div>
<p>Sets the internal netcdf-c rc table value corresponding to key.
See <a href="https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html">https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html</a>
for more information on rc files and values.</p></div>
</dd>
<dt id="netCDF4.set_alignment"><code class="name flex">
<span>def <span class="ident">set_alignment</span></span>(<span>threshold, alignment)</span>
Expand Down
4 changes: 4 additions & 0 deletions src/netCDF4/_netCDF4.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -1323,6 +1323,8 @@ def rc_get(key):
**```rc_get(key)```**
Returns the internal netcdf-c rc table value corresponding to key.
See <https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html>
for more information on rc files and values.
"""
cdef int ierr
cdef char *keyc
Expand All @@ -1345,6 +1347,8 @@ def rc_set(key, value):
**```rc_set(key, value)```**
Sets the internal netcdf-c rc table value corresponding to key.
See <https://docs.unidata.ucar.edu/netcdf-c/current/md_auth.html>
for more information on rc files and values.
"""
cdef int ierr
cdef char *keyc
Expand Down

0 comments on commit 6b4b44c

Please sign in to comment.