Skip to content

Commit a8a4cd7

Browse files
committed
DOCS-quantopian#22: Modify the introduction
Signed-off-by: Richard Lin <[email protected]>
1 parent 64cc1b9 commit a8a4cd7

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,18 @@
77
=================
88
modin-spreadsheet
99
=================
10-
Modin-spreadsheet is a Jupyter notebook widget which uses `SlickGrid <https://github.com/mleibman/SlickGrid>`_ to render pandas
11-
DataFrames within a Jupyter notebook. This allows you to explore your DataFrames with intuitive scrolling, sorting, and
12-
filtering controls, as well as edit your DataFrames by double clicking cells.
13-
14-
TODO: Add about history
15-
16-
Modin-spreadsheet is forked from Qgrid, which was developed by Quantopian. To learn more about Qgrid, here is an `introduction on YouTube <https://www.youtube.com/watch?v=AsJJpgwIX0Q>`_.
10+
Modin-spreadsheet is the underlying package for the `Modin <https://modin.readthedocs.io>`_ Spreadsheet API. It renders
11+
DataFrames within a Jupyter notebook as a spreadsheet and makes it easy to explore with intuitive scrolling, sorting,
12+
and filtering controls. The spreadsheet allows click editing, adding/removing rows, etc. and can also be controlled
13+
using the API. Modin-spreadsheet also records the history of changes made so that you can share or reproduce your
14+
results.
15+
16+
Modin-spreadsheet builds on top of `SlickGrid <https://github.com/mleibman/SlickGrid>`_ and Modin to provide a highly
17+
responsive experience even on DataFrames with 100,000 rows.
18+
19+
Modin-spreadsheet is forked from Qgrid, which was developed by Quantopian. Some documentation will reference Qgrid
20+
documentation as we continue to build out our own documentation. To learn more about Qgrid, here is an
21+
`introduction on YouTube <https://www.youtube.com/watch?v=AsJJpgwIX0Q>`_.
1722

1823
Here is an example of the Modin-spreadsheet widget in action.
1924

0 commit comments

Comments
 (0)