Skip to content

Commit 52b9c8e

Browse files
committed
No longer include changelog, but link to it
1 parent f3c78b6 commit 52b9c8e

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/obelisk/__init__.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,11 @@
77
The PyPi package name is `obelisk-py`, the Python module is called `obelisk`.
88
99
Your starting point will be one of the Obelisk instances in `.sync` or `.asynchronous` depending on your preferred API.
10-
1110
The Obelisk classes in these modules both implement the same interface,
1211
but the asynchronous implementation returns Coroutines.
1312
13+
For Obelisk CORE, look at `obelisk.asynchronous.core`, or the below example as your starting point.
14+
1415
## Error handling
1516
1617
Obelisk-py comes with robust retry logic to handle any errors that may come up.
@@ -77,5 +78,6 @@
7778
```
7879
7980
## Changelog
80-
.. include:: ../../CHANGELOG.rst
81+
82+
See [here](https://github.com/predict-idlab/obelisk-python/blob/main/CHANGELOG.rst)
8183
"""

0 commit comments

Comments
 (0)