Skip to content

Commit 01b1f61

Browse files
Add undocumented storage-related methods to API Ref.
1 parent db2ac82 commit 01b1f61

4 files changed

Lines changed: 30 additions & 9 deletions

File tree

docs/source/class/cf.H5netcdfArray.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Inspection
2323
~cf.H5netcdfArray.get_compression_type
2424
~cf.H5netcdfArray.get_subspace
2525
~cf.H5netcdfArray.get_attributes
26+
~cf.H5netcdfArray.get_variable
2627
~cf.H5netcdfArray.index
2728
~cf.H5netcdfArray.is_subspace
2829

@@ -96,16 +97,18 @@ Miscellaneous
9697

9798
~cf.H5netcdfArray.copy
9899
~cf.H5netcdfArray.to_memory
99-
100-
Active storage
101-
--------------
100+
101+
Active and remote storage
102+
-------------------------
102103

103104
.. autosummary::
104105
:nosignatures:
105106
:toctree: ../method/
106107
:template: method.rst
107108

108109
~cf.H5netcdfArray.active_storage
110+
~cf.H5netcdfArray.get_storage_protocol
111+
~cf.H5netcdfArray.has_remote_storage_protocol
109112

110113
Special
111114
-------

docs/source/class/cf.NetCDF4Array.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Inspection
2323
~cf.NetCDF4Array.get_compression_type
2424
~cf.NetCDF4Array.get_subspace
2525
~cf.NetCDF4Array.get_attributes
26+
~cf.NetCDF4Array.get_variable
2627
~cf.NetCDF4Array.index
2728
~cf.NetCDF4Array.is_subspace
2829

@@ -100,16 +101,18 @@ Miscellaneous
100101
~cf.NetCDF4Array.copy
101102
~cf.NetCDF4Array.to_memory
102103

103-
Active storage
104-
--------------
104+
Active and remote storage
105+
-------------------------
105106

106107
.. autosummary::
107108
:nosignatures:
108109
:toctree: ../method/
109110
:template: method.rst
110111

111112
~cf.NetCDF4Array.active_storage
112-
113+
~cf.NetCDF4Array.get_storage_protocol
114+
~cf.NetCDF4Array.has_remote_storage_protocol
115+
113116
Special
114117
-------
115118

docs/source/class/cf.UMArray.rst

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Inspection
2828
~cf.UMArray.get_word_size
2929
~cf.UMArray.get_mask
3030
~cf.UMArray.get_unpack
31+
~cf.UMArray.get_variable
3132
~cf.UMArray.is_subspace
3233
~cf.UMArray.index
3334

@@ -108,6 +109,17 @@ Special
108109
~cf.UMArray.__dask_tokenize__
109110
~cf.UMArray.__getitem__
110111

112+
Active and remote storage
113+
-------------------------
114+
115+
.. autosummary::
116+
:nosignatures:
117+
:toctree: ../method/
118+
:template: method.rst
119+
120+
~cf.UMArray.get_storage_protocol
121+
~cf.UMArray.has_remote_storage_protocol
122+
111123
Docstring substitutions
112124
-----------------------
113125

docs/source/class/cf.ZarrArray.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Inspection
2323
~cf.ZarrArray.get_compression_type
2424
~cf.ZarrArray.get_subspace
2525
~cf.ZarrArray.get_attributes
26+
~cf.ZarrArray.get_variable
2627
~cf.ZarrArray.index
2728
~cf.ZarrArray.is_subspace
2829

@@ -100,16 +101,18 @@ Miscellaneous
100101
~cf.ZarrArray.copy
101102
~cf.ZarrArray.to_memory
102103

103-
Active storage
104-
--------------
104+
Active and remote storage
105+
-------------------------
105106

106107
.. autosummary::
107108
:nosignatures:
108109
:toctree: ../method/
109110
:template: method.rst
110111

111112
~cf.ZarrArray.active_storage
112-
113+
~cf.ZarrArray.get_storage_protocol
114+
~cf.ZarrArray.has_remote_storage_protocol
115+
113116
Special
114117
-------
115118

0 commit comments

Comments
 (0)