Skip to content

Commit c21b3c3

Browse files
committed
doc: replace var method parameter index with start
1 parent 2c624d2 commit c21b3c3

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

docs/source/tutorial/non_blocking.rst

+8-8
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ Nonblocking Write
1414

1515
Write requests can be posted by the method call of :meth:`Variable.iput_var`.
1616
Same as :meth:`Variable.put_var`, the behavior of :meth:`Variable.iput_var`
17-
varies depending on the pattern of provided optional arguments - `index`,
18-
`start`, `count`, `stride`, and `imap` as shown below. Note that the method
19-
only posts the request, which is not committed until :meth:`File.wait`. The
20-
method call returns a request id that can be optionally passed to
21-
:meth:`File.wait` to select this request.
17+
varies depending on the pattern of provided optional arguments - `start`,
18+
`count`, `stride`, and `imap` as shown below. Note that the method only posts
19+
the request, which is not committed until :meth:`File.wait`. The method call
20+
returns a request id that can be optionally passed to :meth:`File.wait` to
21+
select this request.
2222

2323
- `data` - Request to write an entire variable
24-
- `data`, `index` - Request to write a single data value
24+
- `data`, `start` - Request to write a single data value
2525
- `data`, `start`, `count` - Request to write an array of values
2626
- `data`, `start`, `count`, `stride` - Request to write a subarray of values
2727
- `data`, `start`, `count`, `imap` - Request to write a mapped array of values
@@ -58,10 +58,10 @@ Nonblocking Read
5858
the method call returns a request id that can be optionally passed to
5959
:meth:`File.wait` to select this request. Similar to :meth:`Variable.get_var`,
6060
the behavior of :meth:`Variable.iget_var` varies depending on the pattern of
61-
provided optional arguments - `index`, `start`, `count`, `stride`, and `imap`.
61+
provided optional arguments - `start`, `count`, `stride`, and `imap`.
6262

6363
- `buff` - Request to read an entire variable
64-
- `buff`, `index` - Request to read a single data value
64+
- `buff`, `start` - Request to read a single data value
6565
- `buff`, `start`, `count` - Request to read an array of values
6666
- `buff`, `start`, `count`, `stride` - Request to read a subarray of values
6767
- `buff`, `start`, `count`, `imap` - Request to read a mapped array of values

docs/source/tutorial/read_write.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -42,16 +42,16 @@ Method Call of put_var()/get_var()
4242
written. :meth:`Variable.get_var` requires `buff` as a mandatory argument,
4343
which serves as a read buffer that stores values to be read. The behavior of
4444
:meth:`Variable.put_var` and :meth:`Variable.get_var` varies depending on the
45-
pattern of provided optional arguments - `index`, `start`, `count`, `stride`,
46-
and `imap`. The suffix `_all` indicates this is collective I/O in contrast to
45+
pattern of provided optional arguments - `start`, `count`, `stride`, and
46+
`imap`. The suffix `_all` indicates this is collective I/O in contrast to
4747
independent I/O (without `_all`).
4848

4949
Read from netCDF variables
5050
For reading, the behavior of :meth:`Variable.get_var` depends on the following
5151
provided input parameter pattern:
5252

5353
- `buff` - Read an entire variable
54-
- `buff`, `index` - Read a single data value
54+
- `buff`, `start` - Read a single data value
5555
- `buff`, `start`, `count` - Read an array of values
5656
- `buff`, `start`, `count`, `stride` - Read a subarray of values
5757
- `buff`, `start`, `count`, `imap`, `buff` - Read a mapped array of values
@@ -84,7 +84,7 @@ Write to netCDF variables
8484
provided input parameter pattern:
8585

8686
- `data` - Write an entire variable
87-
- `data`, `index` - Write a single data value (a single element)
87+
- `data`, `start` - Write a single data value (a single element)
8888
- `data`, `start`, `count` - Write an array of values
8989
- `data`, `start`, `count`, `stride` - Write a subarray of values
9090
- `data`, `start`, `count`, `imap` - Write a mapped array of values

0 commit comments

Comments
 (0)