Skip to content

Commit 6825c67

Browse files
committed
Update README
1 parent 4a89a16 commit 6825c67

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,21 @@
22

33
This suite contains tests for dataframe libraries adopting the [Python DataFrame
44
Interchange Protocol](https://data-apis.org/blog/dataframe_protocol_rfc/). Note
5-
it's still a heavy **work in progress**.
5+
it's a **work in progress**.
66

77
### What are we testing?
88

9-
Currently we test
10-
119
* **Round trips** ([`test_from_dataframe.py`](./tests/test_from_dataframe.py)):
1210

13-
1. Create a dataframe in library 1
14-
2. Interchange via library 2 into a "destination" dataframe
15-
3. Interchange that resulting dataframe via library 1 into a "roundtrip" dataframe
11+
1. Creates a dataframe via library 1
12+
2. Interchanges it via library 2 into a "destination" dataframe
13+
3. Interchanges that resulting dataframe via library 1 into a "roundtrip" dataframe
1614

1715
We assert the roundtrip dataframe is equivalent to the original dataframe.
1816

19-
* **Signatures** ([`test_signatures.py`](./tests/test_signatures.py)): Assert functions have the correct signatures.
17+
* **Signatures** ([`test_signatures.py`](./tests/test_signatures.py)): Assert methods have the correct signatures.
2018

21-
As in [`test_dataframe_object.py`](./tests/test_dataframe_object.py), I'm now exploring testing the results of the interchange API methods/properties.
19+
* **Basic functionality** ([`test_dataframe_object.py`](./tests/test_dataframe_object.py)): Smoke methods can take valid input, and assert they return valid output (where appropiate).
2220

2321
### What the heck is `LibraryInfo`?
2422

0 commit comments

Comments
 (0)