Skip to content

Commit

Permalink
Merge pull request #1386 from DWesl/patch-2
Browse files Browse the repository at this point in the history
DOC: More fixes to avoid <code> showing up in docs
  • Loading branch information
jswhit authored Nov 14, 2024
2 parents 5722c9d + af08312 commit b04f3ad
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
16 changes: 8 additions & 8 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1552,8 +1552,8 @@ <h3>Instance variables</h3>
if <code>False</code>, an
exception will be raised if a file with the same name already exists.
mode=<code>x</code> is identical to mode=<code>w</code> with clobber=False.</p>
<p><strong><code>format</code></strong>: underlying file format (one of <code>'NETCDF4',
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'&lt;code&gt;, &lt;/code&gt;'NETCDF3_64BIT_OFFSET'</code> or
<p><strong><code>format</code></strong>: underlying file format (one of <code>'NETCDF4'</code>,
<code>'NETCDF4_CLASSIC'</code>, <code>'NETCDF3_CLASSIC'</code>, <code>'NETCDF3_64BIT_OFFSET'</code> or
<code>'NETCDF3_64BIT_DATA'</code>.
Only relevant if <code>mode = 'w'</code> (if <code>mode = 'r','a'</code> or <code>'r+'</code> the file format
is automatically detected). Default <code>'NETCDF4'</code>, which means the data is
Expand Down Expand Up @@ -1637,8 +1637,8 @@ <h3>Static methods</h3>
suffix replaced by <code>.nc</code> is used..</p>
<p><strong><code>mode</code></strong>:
Access mode to open Dataset (Default <code>'a'</code>).</p>
<p><strong><code>format</code></strong>: underlying file format to use (one of <code>'NETCDF4',
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'&lt;code&gt;, &lt;/code&gt;'NETCDF3_64BIT_OFFSET'</code> or
<p><strong><code>format</code></strong>: underlying file format to use (one of <code>'NETCDF4'</code>,
<code>'NETCDF4_CLASSIC'</code>, <code>'NETCDF3_CLASSIC'</code>, <code>'NETCDF3_64BIT_OFFSET'</code> or
<code>'NETCDF3_64BIT_DATA'</code>. Default <code>'NETCDF4'</code>.</p>
<p>Dataset instance for <code>ncfilename</code> is returned.</p></div>
</dd>
Expand Down Expand Up @@ -1912,8 +1912,8 @@ <h3>Methods</h3>
<code>least_significant_digit</code>. Application programs should never modify
these attributes. The <code>dimensions</code> attribute is a tuple containing the
names of the dimensions associated with this variable. The <code>dtype</code>
attribute is a string describing the variable's data type (<code>i4, f8,
S1,&lt;code&gt; etc). The &lt;/code&gt;shape</code> attribute is a tuple describing the current
attribute is a string describing the variable's data type (<code>i4</code>, <code>f8</code>,
<code>S1</code>, etc). The <code>shape</code> attribute is a tuple describing the current
sizes of all the variable's dimensions. The <code>name</code> attribute is a
string containing the name of the Variable instance.
The <code>least_significant_digit</code>
Expand Down Expand Up @@ -2347,8 +2347,8 @@ <h3>Methods</h3>
<dd>
<div class="desc"><p>Class for reading multi-file netCDF Datasets, making variables
spanning multiple files appear as if they were in one file.
Datasets must be in <code>NETCDF4_CLASSIC, NETCDF3_CLASSIC, NETCDF3_64BIT_OFFSET
or NETCDF3_64BIT_DATA&lt;code&gt; format (&lt;/code&gt;NETCDF4</code> Datasets won't work).</p>
Datasets must be in <code>NETCDF4_CLASSIC</code>, <code>NETCDF3_CLASSIC</code>, <code>NETCDF3_64BIT_OFFSET</code>
or <code>NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).</p>
<p>Adapted from <a href="http://pysclint.sourceforge.net/pycdf">pycdf</a> by Andre Gosselin.</p>
<p>Example usage (See <code><a title="netCDF4.MFDataset" href="#netCDF4.MFDataset">MFDataset</a></code> for more details):</p>
<pre><code class="language-python">&gt;&gt;&gt; import numpy as np
Expand Down
12 changes: 6 additions & 6 deletions src/netCDF4/_netCDF4.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -2985,8 +2985,8 @@ Dataset standard attributes: `dimensions, dtype, shape, ndim, name` and
`least_significant_digit`. Application programs should never modify
these attributes. The `dimensions` attribute is a tuple containing the
names of the dimensions associated with this variable. The `dtype`
attribute is a string describing the variable's data type (`i4, f8,
S1,` etc). The `shape` attribute is a tuple describing the current
attribute is a string describing the variable's data type (`i4`, `f8`,
`S1`, etc). The `shape` attribute is a tuple describing the current
sizes of all the variable's dimensions. The `name` attribute is a
string containing the name of the Variable instance.
The `least_significant_digit`
Expand Down Expand Up @@ -3493,8 +3493,8 @@ suffix replaced by `.nc` is used..
**`mode`**: Access mode to open Dataset (Default `'a'`).
**`format`**: underlying file format to use (one of `'NETCDF4',
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'`, `'NETCDF3_64BIT_OFFSET'` or
**`format`**: underlying file format to use (one of `'NETCDF4'`,
`'NETCDF4_CLASSIC'`, `'NETCDF3_CLASSIC'`, `'NETCDF3_64BIT_OFFSET'` or
`'NETCDF3_64BIT_DATA'`. Default `'NETCDF4'`.
Dataset instance for `ncfilename` is returned.
Expand Down Expand Up @@ -6833,8 +6833,8 @@ class MFDataset(Dataset):
"""
Class for reading multi-file netCDF Datasets, making variables
spanning multiple files appear as if they were in one file.
Datasets must be in `NETCDF4_CLASSIC, NETCDF3_CLASSIC, NETCDF3_64BIT_OFFSET
or NETCDF3_64BIT_DATA` format (`NETCDF4` Datasets won't work).
Datasets must be in `NETCDF4_CLASSIC`, `NETCDF3_CLASSIC`, `NETCDF3_64BIT_OFFSET`
or `NETCDF3_64BIT_DATA` format (`NETCDF4` Datasets won't work).
Adapted from [pycdf](http://pysclint.sourceforge.net/pycdf) by Andre Gosselin.
Expand Down

0 comments on commit b04f3ad

Please sign in to comment.