Skip to content

Commit 570a6da

Browse files
committed
Document the OID class
This commit documents the OID class. Part of #9
1 parent 5f02fc7 commit 570a6da

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

gssapi/raw/oids.pyx

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,18 @@ cdef inline bint c_compare_oids(gss_OID a, gss_OID b):
1111

1212

1313
cdef class OID:
14-
"""
15-
GSSAPI OID
14+
"""GSSAPI OID
15+
16+
A new OID may be created by passing the `elements` argument
17+
to the constructor. The `elements` argument should be a
18+
`bytes` consisting of the BER-encoded values in the OID.
19+
20+
To retrive the underlying bytes, use the :func:`bytes`
21+
function in Python 3 or the :meth:`__bytes__` method directly
22+
in Python 2.
23+
24+
This object is hashable, and may be compared using equality
25+
operators.
1626
"""
1727
# defined in pxd
1828
# cdef gss_OID_desc raw_oid = NULL

0 commit comments

Comments
 (0)