Skip to content

Commit

Permalink
Document the OID class
Browse files Browse the repository at this point in the history
This commit documents the OID class.

Part of #9
  • Loading branch information
DirectXMan12 committed Dec 17, 2014
1 parent 6267367 commit 6a76d04
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions gssapi/raw/oids.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,18 @@ cdef inline bint c_compare_oids(gss_OID a, gss_OID b):


cdef class OID:
"""
GSSAPI OID
"""GSSAPI OID
A new OID may be created by passing the `elements` argument
to the constructor. The `elements` argument should be a
`bytes` consisting of the BER-encoded values in the OID.
To retrive the underlying bytes, use the :func:`bytes`
function in Python 3 or the :meth:`__bytes__` method directly
in Python 2.
This object is hashable, and may be compared using equality
operators.
"""
# defined in pxd
# cdef gss_OID_desc raw_oid = NULL
Expand Down

0 comments on commit 6a76d04

Please sign in to comment.