Skip to content

Commit

Permalink
doc: replace var method parameter index with start
Browse files Browse the repository at this point in the history
  • Loading branch information
wkliao committed Sep 10, 2024
1 parent 2c624d2 commit c21b3c3
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
16 changes: 8 additions & 8 deletions docs/source/tutorial/non_blocking.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ Nonblocking Write

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

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

- `buff` - Request to read an entire variable
- `buff`, `index` - Request to read a single data value
- `buff`, `start` - Request to read a single data value
- `buff`, `start`, `count` - Request to read an array of values
- `buff`, `start`, `count`, `stride` - Request to read a subarray of values
- `buff`, `start`, `count`, `imap` - Request to read a mapped array of values
Expand Down
8 changes: 4 additions & 4 deletions docs/source/tutorial/read_write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,16 +42,16 @@ Method Call of put_var()/get_var()
written. :meth:`Variable.get_var` requires `buff` as a mandatory argument,
which serves as a read buffer that stores values to be read. The behavior of
:meth:`Variable.put_var` and :meth:`Variable.get_var` varies depending on the
pattern of provided optional arguments - `index`, `start`, `count`, `stride`,
and `imap`. The suffix `_all` indicates this is collective I/O in contrast to
pattern of provided optional arguments - `start`, `count`, `stride`, and
`imap`. The suffix `_all` indicates this is collective I/O in contrast to
independent I/O (without `_all`).

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

- `buff` - Read an entire variable
- `buff`, `index` - Read a single data value
- `buff`, `start` - Read a single data value
- `buff`, `start`, `count` - Read an array of values
- `buff`, `start`, `count`, `stride` - Read a subarray of values
- `buff`, `start`, `count`, `imap`, `buff` - Read a mapped array of values
Expand Down Expand Up @@ -84,7 +84,7 @@ Write to netCDF variables
provided input parameter pattern:

- `data` - Write an entire variable
- `data`, `index` - Write a single data value (a single element)
- `data`, `start` - Write a single data value (a single element)
- `data`, `start`, `count` - Write an array of values
- `data`, `start`, `count`, `stride` - Write a subarray of values
- `data`, `start`, `count`, `imap` - Write a mapped array of values
Expand Down

0 comments on commit c21b3c3

Please sign in to comment.