[27527] in Source-Commits
python-afs commit: Update docstrings for Cython functions
daemon@ATHENA.MIT.EDU (Jonathan D Reed)
Tue Nov 12 18:27:56 2013
Date: Tue, 12 Nov 2013 18:27:49 -0500
From: Jonathan D Reed <jdreed@MIT.EDU>
Message-Id: <201311122327.rACNRn0n018716@drugstore.mit.edu>
To: source-commits@MIT.EDU
https://github.com/mit-athena/python-afs/commits/9560c240e3e0c76fdfffdea2677a0fc73932ba71
commit 9560c240e3e0c76fdfffdea2677a0fc73932ba71
Author: Jonathan Reed <jdreed@mit.edu>
Date: Wed Oct 30 12:07:10 2013 -0400
Update docstrings for Cython functions
Update the docstring for whichcell, because its signature can't
be determine by introspection, and it's exported into afs.fs.
Correct typo in docstring for _lsmount
afs/_fs.pyx | 8 ++++++--
1 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/afs/_fs.pyx b/afs/_fs.pyx
index 7642cae..31ee0f6 100644
--- a/afs/_fs.pyx
+++ b/afs/_fs.pyx
@@ -11,7 +11,11 @@ __all__ = ['whichcell',
]
def whichcell(char* path):
- """Determine which AFS cell a particular path is in."""
+ """
+ whichcell(path) -> str
+
+ Determine which AFS cell a particular path is in.
+ """
cdef char cell[MAXCELLCHARS]
pioctl_read(path, VIOC_FILE_CELL_NAME, cell, sizeof(cell), 1)
@@ -19,7 +23,7 @@ def whichcell(char* path):
def _lsmount(char* parent, char* path):
"""
- lsmount(parent, path) -> str
+ _lsmount(parent, path) -> str
Given the parent directory, and a path, return the name of the
volume. Raises OSError.
