Skip to content

Commit 9311683

Browse files
committed
doc string fixes
1 parent 22f4ffd commit 9311683

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

irods/access.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,19 @@ def copy(self, decanonicalize=False, implied_zone=''):
129129
Create a copy of the object, possibly in a normalized form.
130130
131131
Args:
132-
decanonicalize: Whether to modify to access_name field to a more human-readable (1/True)
133-
or more standard (-1) form. If the former, then a more organic style is favored, i.e.
132+
decanonicalize: Whether to modify to access_name field to a more human-readable (when 1 i.e. True)
133+
or more standard form (when -1). If the former, then a more organic style is favored, i.e.
134134
"read" and "write". If the latter, the new access_name will be more machine-friendly
135135
for operators __lt__ (for sorting) and __eq__ (for equivalence or use with 'in').
136+
If equal to (0 i.e. False), no adjustment is done.
136137
implied_zone: If a nonzero-length name, compare this against the zone_name field of the
137138
old object, and if they match, force the zone_name to zero-length in the new object.
138139
139140
Returns:
140141
A copy of the invoking object, normalized if requested.
142+
143+
Raises:
144+
RuntimeError: if decanonicalize parameter is not one of {-1,0,False,1,True}.
141145
"""
142146
other = copy.deepcopy(self)
143147

0 commit comments

Comments
 (0)