Skip to content
This repository was archived by the owner on Jun 10, 2022. It is now read-only.

Commit a1294c3

Browse files
committed
update usage in readme
1 parent 20d979e commit a1294c3

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ pandas-compat
55

66
**pandas-compat** is a package providing an API compatibility across versions to downstream libraries that use pandas.
77

8+
This compatibility layer requires ``pandas`` >= 0.17.0.
9+
810

911
Installation
1012
------------
@@ -35,6 +37,15 @@ Install latest development version
3537
Usage
3638
-----
3739

40+
In your downstream library, you can use this pattern:
41+
42+
.. code-block:: python
43+
44+
import pandas_compat as pdc
45+
46+
pdc.is_datetime64tz_dtype(...)
47+
pdc.infer_dtype(...)
48+
3849
3950
.. |Build Status| image:: https://travis-ci.org/pandas-dev/pandas-compat.svg?branch=master
4051
:target: https://travis-ci.org/pandas-dev/pandas-compat

0 commit comments

Comments
 (0)