docs: update README to use udtf

wheretrue · Dec 19, 2023 · 9188962 · 9188962
1 parent 464fc1c
commit 9188962
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -33,7 +33,11 @@ Then you can use biobear to read a file:
 ```python
 import biobear as bb
 
-df = bb.GFFReader("test.gff").to_polars()
+session = bb.connect()
+df = session.sql("""
+    SELECT * FROM gff_scan('test.gff')
+""").to_polars()
+
 print(df)
 ```
 

diff --git a/python/biobear/deprecated.py b/python/biobear/deprecated.py
@@ -17,6 +17,7 @@
 
 
 def deprecated(cls):
+    """Class decorator to mark a class as deprecated."""
     orig_init = cls.__init__
 
     @functools.wraps(orig_init)