Skip to content

Commit a91a976

Browse files
committed
docs: add libver example strings
1 parent 3c127f1 commit a91a976

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

src/pnetcdf/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ def libver():
1717
"""
1818
libver()
1919
20-
:return: PnetCDF-Python version string.
20+
:return: The PnetCDF-Python version string, for example "1.0.0".
2121
:rtype: str
2222
"""
2323
return __version__

src/pnetcdf/_utils.pyx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -799,7 +799,8 @@ cpdef inq_clibvers():
799799
library used to build this PnetCDF-Python module, and when the PnetCDF-C
800800
library was built.
801801
802-
:return: a string about PnetCDF-C library
802+
:return: A string about PnetCDF-C library, for example, "1.13.0 of March 29, 2024".
803+
803804
:rtype: str
804805
"""
805806
ver_str = (<char *>ncmpi_inq_libvers()).decode('ascii')

0 commit comments

Comments
 (0)