Skip to content

Commit 062c2ca

Browse files
authored
Clarify API doc (#106)
1 parent 3930606 commit 062c2ca

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

imas/db_entry.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,10 @@ def __init__(
113113
object before you can use it for reading or writing data.
114114
115115
Args:
116-
uri: URI to the data entry, see explanation above.
116+
uri: URI to the data entry (a path to a netCDF file ending with .nc,
117+
or an `IMAS URI for one of IMAS-Core's backends
118+
<https://imas-core.readthedocs.io/en/latest/user_guide/uris_guide.html>`__
119+
).
117120
mode: Mode to open the Data Entry in:
118121
119122
- ``"r"``: Open an existing data entry. Raises an error when the data

0 commit comments

Comments
 (0)