Skip to content

Commit

Permalink
docs: import ibis in doctests
Browse files Browse the repository at this point in the history
This was failing to render in the
reference sections of the docs.
  • Loading branch information
NickCrews authored and cpcloud committed Sep 27, 2023
1 parent a80bb75 commit 7f340de
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions ibis/backends/base/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -1170,13 +1170,13 @@ def connect(resource: Path | str, **kwargs: Any) -> BaseBackend:
The general pattern for `ibis.connect` is
```python
ibis.connect("backend://connection-parameters")
con = ibis.connect("backend://connection-parameters")
```
With many backends that looks like
```python
ibis.connect("backend://user:password@host:port/database")
con = ibis.connect("backend://user:password@host:port/database")
```
See the connection syntax for each backend for details about URL connection
Expand All @@ -1193,6 +1193,7 @@ def connect(resource: Path | str, **kwargs: Any) -> BaseBackend:
--------
Connect to an in-memory DuckDB database:
>>> import ibis
>>> con = ibis.connect("duckdb://")
Connect to an on-disk SQLite database:
Expand Down

0 comments on commit 7f340de

Please sign in to comment.