Skip to content

Commit 3142325

Browse files
committed
Finish general cleanup of doc files
1 parent 9b2ccbf commit 3142325

35 files changed

+188
-182
lines changed

DatasetOps/DELETE_Dataset.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
5151
Special Errors
5252
--------------
5353

54-
The implementation of the operation does not return special errors. For general
54+
This implementation of the operation does not return special errors. For general
5555
information on standard error codes, see :doc:`../CommonErrorResponses`.
5656

5757
Examples

DatasetOps/GET_Dataset.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
8282
Special Errors
8383
--------------
8484

85-
The implementation of the operation does not return special errors. For general
85+
This implementation of the operation does not return special errors. For general
8686
information on standard error codes, see :doc:`../CommonErrorResponses`.
8787

8888
Examples

DatasetOps/GET_DatasetShape.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ GET Shape
44

55
Description
66
===========
7-
Gets shape of a dataset.
7+
Gets the shape of a dataset.
88

99
Requests
1010
========
@@ -50,20 +50,20 @@ A JSON object with the following keys:
5050
class: A string with one of the following values:
5151

5252
* H5S_NULL: A null dataspace, which has no elements
53-
* H5S_SCALAR: A dataspace with a single element (although possibly of a complext datatype)
53+
* H5S_SCALAR: A dataspace with a single element (although possibly of a complex datatype)
5454
* H5S_SIMPLE: A dataspace that consists of a regular array of elements
5555

5656
dims: An integer array whose length is equal to the number of dimensions (rank) of the
57-
dataspace. The value of each element gives the the current size of each dimension. Dims
57+
dataspace. The value of each element gives the current size of each dimension. Dims
5858
is not returned for H5S_NULL or H5S_SCALAR dataspaces.
5959

6060
maxdims: An integer array whose length is equal to the number of dimensions of the
6161
dataspace. The value of each element gives the maximum size of each dimension. A value
6262
of 0 indicates that the dimension has *unlimited* extent. maxdims is not returned for
6363
H5S_SIMPLE dataspaces which are not extensible or for H5S_NULL or H5S_SCALAR dataspaces.
6464

65-
fillvalue: A value of compatible with the dataset's type, which gives the *fill* value
66-
for the dataset (the value for which elements will be initialized to when a dataspace
65+
fillvalue: A value, of a type compatible with the dataset's type, which gives the *fill* value
66+
for the dataset (the value which elements will be initialized to when a dataspace
6767
is extended). fillvalue is only returned for extensible dataspaces.
6868

6969
created
@@ -83,7 +83,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
8383
Special Errors
8484
--------------
8585

86-
The implementation of the operation does not return special errors. For general
86+
This implementation of the operation does not return special errors. For general
8787
information on standard error codes, see :doc:`../CommonErrorResponses`.
8888

8989
Examples

DatasetOps/GET_DatasetType.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
5454
Special Errors
5555
--------------
5656

57-
The implementation of the operation does not return special errors. For general
57+
This implementation of the operation does not return special errors. For general
5858
information on standard error codes, see :doc:`../CommonErrorResponses`.
5959

6060
Examples

DatasetOps/GET_Datasets.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ optional):
2424

2525
Limit
2626
^^^^^
27-
If provided, a positive integer value specifying the maximum number of UUID's to return.
27+
If provided, a positive integer value specifying the maximum number of UUIDs to return.
2828

2929
Marker
3030
^^^^^^
31-
If provided, a string value indicating that only UUID's that occur after the
31+
If provided, a string value indicating that only UUIDs that occur after the
3232
marker value will be returned.
3333

3434
Request Headers
@@ -52,7 +52,7 @@ On success, a JSON response will be returned with the following elements:
5252

5353
datasets
5454
^^^^^^^^
55-
An array of UUID's, one for each dataset in the domain.
55+
An array of UUIDs, one for each dataset in the domain.
5656

5757
hrefs
5858
^^^^^
@@ -61,7 +61,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
6161
Special Errors
6262
--------------
6363

64-
The implementation of the operation does not return special errors. For general
64+
This implementation of the operation does not return special errors. For general
6565
information on standard error codes, see :doc:`../CommonErrorResponses`.
6666

6767
Examples

DatasetOps/GET_Value.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,8 +68,8 @@ of "application/octet-stream". Use this accept value if a binary response is de
6868
more efficient for large data requests. If a binary response can be returned, the "Content-Type" response
6969
header will be "application/octet-stream". Otherwise the response header will be "json".
7070

71-
Note: Binary responses are only supported for dataset that have a fixed-length type
72-
(i.e. either a fixed length primitive type or compound type that in turn consists of fixed=length types). Namely
71+
Note: Binary responses are only supported for datasets that have a fixed-length type
72+
(i.e. either a fixed length primitive type or compound type that in turn consists of fixed-length types). Namely
7373
variable length strings and variable length data types will always be returned as JSON.
7474

7575
Note: if a binary response is returned, it will consist of the equivalent binary data of the "data" item in the JSON
@@ -98,7 +98,7 @@ dataset region.
9898

9999
index
100100
^^^^^
101-
A list of indexes for each element that met the query condition (only provided when
101+
A list of indices for each element that met the query condition (only provided when
102102
the query request parameter is used).
103103

104104
hrefs
@@ -108,7 +108,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
108108
Special Errors
109109
--------------
110110

111-
The implementation of the operation does not return special errors. For general
111+
This implementation of the operation does not return special errors. For general
112112
information on standard error codes, see :doc:`../CommonErrorResponses`.
113113

114114
Examples
@@ -209,7 +209,7 @@ Sample Response - Selection
209209
Sample Request - Query
210210
--------------------------
211211

212-
Get elements from dataset where the 'date' field is equal to 20 and the 'temp' field is greater or equal to 70.
212+
Get elements from dataset where the 'date' field is equal to 20 and the 'temp' field is greater than or equal to 70.
213213

214214
.. code-block:: http
215215

DatasetOps/POST_Dataset.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The request body must include a JSON object with a "type" key. Optionally "shap
3333

3434
type
3535
^^^^
36-
Either a string that is one of the predefined type values, a uuid of a committed type,
36+
Either a string that is one of the predefined type values, a UUID of a committed type,
3737
or a JSON object describing the type. See :doc:`../Types/index` for details of the
3838
type specification.
3939

@@ -49,7 +49,7 @@ dataset has attributes and a type, but will not be able to store any values.
4949
maxdims
5050
^^^^^^^
5151
An integer array describing the maximum extent of each dimension (or 0 for unlimited
52-
dimensions). If maxdims is not provided that resulting dataset will be non-extensible.
52+
dimensions). If maxdims is not provided the resulting dataset will be non-extensible.
5353
Not valid to include if ``H5S_NULL`` is specified for the shape.
5454

5555
creationProperties
@@ -58,12 +58,12 @@ A JSON object that can specify chunk layout, filters, fill value, and other aspe
5858
See: http://hdf5-json.readthedocs.org/en/latest/bnf/dataset.html#grammar-token-dcpl for a complete
5959
description of fields that can be used.
6060

61-
If creationProperties is not provided, default values will be used
61+
If creationProperties is not provided, default values will be used.
6262

6363
link["id"]
6464
^^^^^^^^^^
65-
The UUID of the group the new group should be linked to. If the UUID is not valid,
66-
the request will fail and a new group will not be created.
65+
The UUID of the group that the new dataset should be linked to. If the UUID is not valid,
66+
the request will fail and a new dataset will not be created.
6767

6868
link["name"]
6969
^^^^^^^^^^^^
@@ -107,7 +107,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
107107
Special Errors
108108
--------------
109109

110-
The implementation of the operation does not return special errors. For general
110+
This implementation of the operation does not return special errors. For general
111111
information on standard error codes, see :doc:`../CommonErrorResponses`.
112112

113113
Examples
@@ -272,7 +272,7 @@ Sample Response - Resizable Dataset
272272
Sample Request - Committed Type
273273
----------------------------------
274274

275-
Create a two-dimensional dataset which uses a committed type with uuid:
275+
Create a two-dimensional dataset which uses a committed type with UUID:
276276

277277
.. code-block:: http
278278

DatasetOps/POST_Value.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ POST Value
44

55
Description
66
===========
7-
Gets values of a data for a given point selection (provided in the body of the
7+
Gets values of a dataset for a given point selection (provided in the body of the
88
request).
99

1010
Requests
@@ -58,13 +58,13 @@ On success, a JSON response will be returned with the following elements:
5858
value
5959
^^^^^
6060
An array of values where the length of the array is equal to the number of points
61-
in the request. Each value will be a string, integer, or JSON object consist
62-
with the dataset type (e.g. an compound type).
61+
in the request. Each value will be a string, integer, or JSON object consistent
62+
with the dataset type (e.g. a compound type).
6363

6464
Special Errors
6565
--------------
6666

67-
The implementation of the operation does not return special errors. For general
67+
This implementation of the operation does not return special errors. For general
6868
information on standard error codes, see :doc:`../CommonErrorResponses`.
6969

7070
Examples

DatasetOps/PUT_DatasetShape.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ An array of links to related resources. See :doc:`../Hypermedia`.
6161
Special Errors
6262
--------------
6363

64-
The implementation of the operation does not return special errors. For general
64+
This implementation of the operation does not return special errors. For general
6565
information on standard error codes, see :doc:`../CommonErrorResponses`.
6666

6767
Examples

DatasetOps/PUT_Value.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ start:
3737
An optional key that gives the starting coordinate of the selection to be updated. The
3838
start value can either be an integer (for 1 dimensional arrays) or an array of integers
3939
where the length of the array is equal to the number of dimensions of the dataset. Each
40-
value must be greater than equal to zero and less than the extent of the corresponding
40+
value must be greater than or equal to zero and less than the extent of the corresponding
4141
dimension.
4242

4343
If start is not provided, the selection starts at 0 for each dimension.
@@ -47,22 +47,22 @@ stop:
4747
An optional key that gives the ending coordinate of the selection to be updated.
4848
The stop value can either be an integer (for 1 dimensional arrays) or an array of integers
4949
where the length of the array is equal to the number of dimensions of the dataset. Each
50-
value must be greater than equal to start (or zero if start is not provided) and less than
50+
value must be greater than or equal to start (or zero if start is not provided) and less than
5151
the extent of the corresponding dimension.
5252

5353
step:
5454
^^^^^
5555
An optional key that gives the step value (i.e. the increment of the coordinate for
5656
each supplied value). The step value can either be an integer (for 1 dimensional arrays) or
5757
an array of integers where the length of the array is equal to the number of dimensions of
58-
the dataset. Each value must be greater than equal to start (or zero if start is not
58+
the dataset. Each value must be greater than or equal to start (or zero if start is not
5959
provided) and less than or equal to the extent of the corresponding dimension.
6060

6161
points:
6262
^^^^^^^
6363

64-
An optional key that contains a list of array elements to be updated. Each element of the list should be an
65-
an integer if the dataset is of rank 1 or an n-element list (which n is the dataset rank) is the dataset
64+
An optional key that contains a list of array elements to be updated. Each element of the list should be
65+
an integer if the dataset is of rank 1 or an n-element list (where n is the dataset rank) if the dataset
6666
rank is greater than 1. If points is provided (indicating a point selection update), then start, stop,
6767
and step (used for hyperslab selection) should not be provied.
6868

@@ -96,7 +96,7 @@ No response elements are returned.
9696
Special Errors
9797
--------------
9898

99-
The implementation of the operation does not return special errors. For general
99+
This implementation of the operation does not return special errors. For general
100100
information on standard error codes, see :doc:`../CommonErrorResponses`.
101101

102102
Examples
@@ -106,7 +106,7 @@ Examples
106106
Sample Request
107107
--------------
108108

109-
This example writes a 10x10 integer datasets with the values 0-99 inclusive.
109+
This example writes a 10x10 integer dataset with the values 0-99 inclusive.
110110

111111
.. code-block:: http
112112

0 commit comments

Comments
 (0)