Alpha release

YoSTEALTH · Apr 22, 2024 · 2751459 · 2751459
1 parent dd35fe7
commit 2751459
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 14 deletions.
diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
 |test-status| |downloads|
 
-Liburing (Work in progress ... )
-================================
+Liburing
+========
 
 Liburing is Python + Cython wrapper around `C Liburing`_, which is a helper to setup and tear-down io_uring instances.
 
@@ -24,7 +24,7 @@ Requires
 Includes (battery)
 ------------------
 
-    - C liburing 2.6+
+    - C liburing 2.5+
 
 
 Install, update & uninstall (Alpha)
@@ -165,6 +165,7 @@ Cython Note
 
 TODO
 ----
+    - Stable Release (currently still in alpha)
     - Linux 6.1 Backwards compatibility.
 
 

diff --git a/setup.py b/setup.py
@@ -47,6 +47,7 @@ def build_extensions(self):
     Options.fast_fail = True
     Options.docstrings = True
     Options.warning_errors = False
+
     try:
         lib = join(tmpdir, 'libs/liburing')
         libsrc = join(lib, 'src')
@@ -63,11 +64,9 @@ def build_extensions(self):
         setup(cmdclass={'build_ext': BuildExt},
               ext_modules=cythonize(extension,
                                     nthreads=threads,
-                                    compiler_directives={
-                                        'embedsignature': True,  # show all `__doc__`
-                                        'boundscheck': False,
-                                        'wraparound': False,
-                                        'language_level': 3,
-                                        'show_performance_hints': False}))
+                                    compiler_directives={'embedsignature': True,  # show `__doc__`
+                                                         'boundscheck': False,
+                                                         'wraparound': False,
+                                                         'language_level': 3}))
     finally:
         rmtree(tmpdir)
diff --git a/src/liburing/queue.pxd b/src/liburing/queue.pxd
@@ -13,9 +13,9 @@ cdef class io_uring:
 
 cdef class io_uring_sqe:
     cdef:
-        __io_uring_sqe*     ptr
-        __u16               len
-        list[io_uring_sqe]  ref
+        __io_uring_sqe* ptr
+        __u16           len
+        list[object]    ref
 
 
 cdef class io_uring_cqe:

diff --git a/src/liburing/queue.pyx b/src/liburing/queue.pyx
@@ -207,11 +207,11 @@ cdef class io_uring_cqe:
 
             Example
                 >>> index = 1
-                >>> cqe.get_result(index)
+                >>> cqe.get_index(index)
                 (0, 123)
 
             Note
-                - Just like `__getitem__` but faster and no error checking!
+                - Just like `__getitem__` but faster!
         '''
         if self.active or self.ptr is not NULL:
             if index == 0: