diff options
| author | Pat Gunn <pgunn@mongodb.com> | 2015-04-25 23:05:50 -0400 |
|---|---|---|
| committer | Pat Gunn <pgunn@mongodb.com> | 2015-04-25 23:05:50 -0400 |
| commit | 2e2471f2ec70a9fe57a7be8e195eb69a221da63b (patch) | |
| tree | 179f2132f26645e158d8f8f324f90934c34350c0 | |
| parent | 917e850020594f4e15c0386a56a7fba0192671ea (diff) | |
| download | mongo-2e2471f2ec70a9fe57a7be8e195eb69a221da63b.tar.gz | |
Fix a typo, add what will be a description section for pydoc
| -rw-r--r-- | lang/python/wiredtiger.i | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/lang/python/wiredtiger.i b/lang/python/wiredtiger.i index c46fd6d24a6..f9218d7529c 100644 --- a/lang/python/wiredtiger.i +++ b/lang/python/wiredtiger.i @@ -31,10 +31,16 @@ * The SWIG interface file defining the wiredtiger python API. */ %define DOCSTRING -"@defgroup wt_python WiredTiger Python API -Python wrappers aroung the WiredTiger C API. -@{ -@cond IGNORE" +"Python wrappers around the WiredTiger C API + +This provides an API similar to the C API, with the following modifications: + - Many C functions are exposed as OO methods. See the Python examples and test suite + - Errors are handled in a Pythonic way; wrap calls in try/except blocks + - Cursors have extra accessor methods and iterators that are higher-level than the C API + - Statistics cursors behave a little differently and are best handled using the C-like functions + - C Constants starting with WT_STAT_DSRC are instead exposed under wiredtiger.stat.dsrc + - C Constants starting with WT_STAT_CONN are instead exposed under wiredtiger.stat.conn +" %enddef %module(docstring=DOCSTRING) wiredtiger |