Skip to content

Commit b04f3ad

Browse files
author
Jeff Whitaker
authored
Merge pull request Unidata#1386 from DWesl/patch-2
DOC: More fixes to avoid <code> showing up in docs
2 parents 5722c9d + af08312 commit b04f3ad

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/index.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1552,8 +1552,8 @@ <h3>Instance variables</h3>
15521552
if <code>False</code>, an
15531553
exception will be raised if a file with the same name already exists.
15541554
mode=<code>x</code> is identical to mode=<code>w</code> with clobber=False.</p>
1555-
<p><strong><code>format</code></strong>: underlying file format (one of <code>'NETCDF4',
1556-
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'&lt;code&gt;, &lt;/code&gt;'NETCDF3_64BIT_OFFSET'</code> or
1555+
<p><strong><code>format</code></strong>: underlying file format (one of <code>'NETCDF4'</code>,
1556+
<code>'NETCDF4_CLASSIC'</code>, <code>'NETCDF3_CLASSIC'</code>, <code>'NETCDF3_64BIT_OFFSET'</code> or
15571557
<code>'NETCDF3_64BIT_DATA'</code>.
15581558
Only relevant if <code>mode = 'w'</code> (if <code>mode = 'r','a'</code> or <code>'r+'</code> the file format
15591559
is automatically detected). Default <code>'NETCDF4'</code>, which means the data is
@@ -1637,8 +1637,8 @@ <h3>Static methods</h3>
16371637
suffix replaced by <code>.nc</code> is used..</p>
16381638
<p><strong><code>mode</code></strong>:
16391639
Access mode to open Dataset (Default <code>'a'</code>).</p>
1640-
<p><strong><code>format</code></strong>: underlying file format to use (one of <code>'NETCDF4',
1641-
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'&lt;code&gt;, &lt;/code&gt;'NETCDF3_64BIT_OFFSET'</code> or
1640+
<p><strong><code>format</code></strong>: underlying file format to use (one of <code>'NETCDF4'</code>,
1641+
<code>'NETCDF4_CLASSIC'</code>, <code>'NETCDF3_CLASSIC'</code>, <code>'NETCDF3_64BIT_OFFSET'</code> or
16421642
<code>'NETCDF3_64BIT_DATA'</code>. Default <code>'NETCDF4'</code>.</p>
16431643
<p>Dataset instance for <code>ncfilename</code> is returned.</p></div>
16441644
</dd>
@@ -1912,8 +1912,8 @@ <h3>Methods</h3>
19121912
<code>least_significant_digit</code>. Application programs should never modify
19131913
these attributes. The <code>dimensions</code> attribute is a tuple containing the
19141914
names of the dimensions associated with this variable. The <code>dtype</code>
1915-
attribute is a string describing the variable's data type (<code>i4, f8,
1916-
S1,&lt;code&gt; etc). The &lt;/code&gt;shape</code> attribute is a tuple describing the current
1915+
attribute is a string describing the variable's data type (<code>i4</code>, <code>f8</code>,
1916+
<code>S1</code>, etc). The <code>shape</code> attribute is a tuple describing the current
19171917
sizes of all the variable's dimensions. The <code>name</code> attribute is a
19181918
string containing the name of the Variable instance.
19191919
The <code>least_significant_digit</code>
@@ -2347,8 +2347,8 @@ <h3>Methods</h3>
23472347
<dd>
23482348
<div class="desc"><p>Class for reading multi-file netCDF Datasets, making variables
23492349
spanning multiple files appear as if they were in one file.
2350-
Datasets must be in <code>NETCDF4_CLASSIC, NETCDF3_CLASSIC, NETCDF3_64BIT_OFFSET
2351-
or NETCDF3_64BIT_DATA&lt;code&gt; format (&lt;/code&gt;NETCDF4</code> Datasets won't work).</p>
2350+
Datasets must be in <code>NETCDF4_CLASSIC</code>, <code>NETCDF3_CLASSIC</code>, <code>NETCDF3_64BIT_OFFSET</code>
2351+
or <code>NETCDF3_64BIT_DATA</code> format (<code>NETCDF4</code> Datasets won't work).</p>
23522352
<p>Adapted from <a href="http://pysclint.sourceforge.net/pycdf">pycdf</a> by Andre Gosselin.</p>
23532353
<p>Example usage (See <code><a title="netCDF4.MFDataset" href="#netCDF4.MFDataset">MFDataset</a></code> for more details):</p>
23542354
<pre><code class="language-python">&gt;&gt;&gt; import numpy as np

src/netCDF4/_netCDF4.pyx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2985,8 +2985,8 @@ Dataset standard attributes: `dimensions, dtype, shape, ndim, name` and
29852985
`least_significant_digit`. Application programs should never modify
29862986
these attributes. The `dimensions` attribute is a tuple containing the
29872987
names of the dimensions associated with this variable. The `dtype`
2988-
attribute is a string describing the variable's data type (`i4, f8,
2989-
S1,` etc). The `shape` attribute is a tuple describing the current
2988+
attribute is a string describing the variable's data type (`i4`, `f8`,
2989+
`S1`, etc). The `shape` attribute is a tuple describing the current
29902990
sizes of all the variable's dimensions. The `name` attribute is a
29912991
string containing the name of the Variable instance.
29922992
The `least_significant_digit`
@@ -3493,8 +3493,8 @@ suffix replaced by `.nc` is used..
34933493
34943494
**`mode`**: Access mode to open Dataset (Default `'a'`).
34953495
3496-
**`format`**: underlying file format to use (one of `'NETCDF4',
3497-
'NETCDF4_CLASSIC', 'NETCDF3_CLASSIC'`, `'NETCDF3_64BIT_OFFSET'` or
3496+
**`format`**: underlying file format to use (one of `'NETCDF4'`,
3497+
`'NETCDF4_CLASSIC'`, `'NETCDF3_CLASSIC'`, `'NETCDF3_64BIT_OFFSET'` or
34983498
`'NETCDF3_64BIT_DATA'`. Default `'NETCDF4'`.
34993499
35003500
Dataset instance for `ncfilename` is returned.
@@ -6833,8 +6833,8 @@ class MFDataset(Dataset):
68336833
"""
68346834
Class for reading multi-file netCDF Datasets, making variables
68356835
spanning multiple files appear as if they were in one file.
6836-
Datasets must be in `NETCDF4_CLASSIC, NETCDF3_CLASSIC, NETCDF3_64BIT_OFFSET
6837-
or NETCDF3_64BIT_DATA` format (`NETCDF4` Datasets won't work).
6836+
Datasets must be in `NETCDF4_CLASSIC`, `NETCDF3_CLASSIC`, `NETCDF3_64BIT_OFFSET`
6837+
or `NETCDF3_64BIT_DATA` format (`NETCDF4` Datasets won't work).
68386838
68396839
Adapted from [pycdf](http://pysclint.sourceforge.net/pycdf) by Andre Gosselin.
68406840

0 commit comments

Comments
 (0)