Skip to content

Commit 0f7fd8b

Browse files
committed
DOCS-quantopian#22: Change modin-spreadsheet name to uppercase
Signed-off-by: Richard Lin <[email protected]>
1 parent a3d9577 commit 0f7fd8b

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
:alt: Modin
66

77
=================
8-
modin-spreadsheet
8+
Modin-spreadsheet
99
=================
1010
Modin-spreadsheet is the underlying package for the `Modin <https://modin.readthedocs.io>`_ Spreadsheet API. It renders
1111
DataFrames within a Jupyter notebook as a spreadsheet and makes it easy to explore with intuitive scrolling, sorting,
@@ -36,7 +36,7 @@ Full documentation for Modin-spreadsheet is still in progress. Most features are
3636

3737
Installation
3838
------------
39-
Modin-spreadsheet is intended be used through the `Modin Spreadsheet API <https://modin.readthedocs.io>`_ (Docs in progress...). Please install Modin and modin-spreadsheet by running the following: ::
39+
Modin-spreadsheet is intended be used through the `Modin Spreadsheet API <https://modin.readthedocs.io>`_ (Docs in progress...). Please install Modin and Modin-spreadsheet by running the following: ::
4040

4141
pip install modin
4242
pip install modin[spreadsheet]
@@ -99,8 +99,8 @@ The Events API provides ``on`` and ``off`` methods which can be used to attach/d
9999
on both the ``modin_spreadsheet`` module (see `qgrid.on <https://qgrid.readthedocs.io/en/latest/#qgrid.on>`_), and on
100100
individual SpreadsheetWidget instances (see `qgrid.QgridWidget.on <https://qgrid.readthedocs.io/en/latest/#qgrid.QgridWidget.on>`_).
101101

102-
Having the ability to attach event handlers allows us to do some interesting things in terms of using modin-spreadsheet
103-
in conjunction with other widgets/visualizations. One example is using modin-spreadsheet to filter a DataFrame that's
102+
Having the ability to attach event handlers allows us to do some interesting things in terms of using Modin-spreadsheet
103+
in conjunction with other widgets/visualizations. One example is using Modin-spreadsheet to filter a DataFrame that's
104104
also being displayed by another visualization.
105105

106106
Here's how you would use the ``on`` method to print the DataFrame every time there's a change made::
@@ -114,7 +114,7 @@ Here's how you would use the ``on`` method to print the DataFrame every time the
114114

115115
Here are some examples of how the Events API can be applied.
116116

117-
This shows how you can use modin-spreadsheet to filter the data that's being shown by a matplotlib scatter plot:
117+
This shows how you can use Modin-spreadsheet to filter the data that's being shown by a matplotlib scatter plot:
118118

119119
.. figure:: docs/images/linked_to_scatter.gif
120120
:align: left
@@ -136,8 +136,8 @@ the functionality is the same on Jupyter Notebook.
136136
Running from source & testing your changes
137137
------------------------------------------
138138

139-
If you'd like to contribute to modin-spreadsheet, or just want to be able to modify the source code for your own purposes, you'll
140-
want to clone this repository and run modin-spreadsheet from your local copy of the repository. The following steps explain how
139+
If you'd like to contribute to Modin-spreadsheet, or just want to be able to modify the source code for your own purposes, you'll
140+
want to clone this repository and run Modin-spreadsheet from your local copy of the repository. The following steps explain how
141141
to do this.
142142

143143
#. Clone the repository from GitHub and ``cd`` into the top-level directory::
@@ -150,11 +150,11 @@ to do this.
150150

151151
pip install -e .
152152

153-
#. Install the node packages that modin-spreadsheet depends on and build modin-spreadsheet's javascript using webpack::
153+
#. Install the node packages that Modin-spreadsheet depends on and build Modin-spreadsheet's javascript using webpack::
154154

155155
cd js && npm install .
156156

157-
#. Install and enable modin-spreadsheet's javascript in your local jupyter notebook environment::
157+
#. Install and enable Modin-spreadsheet's javascript in your local jupyter notebook environment::
158158

159159
jupyter nbextension install --py --symlink --sys-prefix modin_spreadsheet && jupyter nbextension enable --py --sys-prefix modin_spreadsheet
160160

@@ -164,12 +164,12 @@ to do this.
164164

165165
Manually testing server-side changes
166166
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
167-
If the code you need to change is in modin-spreadsheet's python code, then restart the kernel of the notebook you're in and
168-
rerun any modin-spreadsheet cells to see your changes take effect.
167+
If the code you need to change is in Modin-spreadsheet's python code, then restart the kernel of the notebook you're in and
168+
rerun any Modin-spreadsheet cells to see your changes take effect.
169169

170170
Manually testing client-side changes
171171
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
172-
If the code you need to change is in modin-spreadsheet's javascript or css code, repeat step 3 to rebuild modin-spreadsheet's npm package,
172+
If the code you need to change is in Modin-spreadsheet's javascript or css code, repeat step 3 to rebuild Modin-spreadsheet's npm package,
173173
then refresh the browser tab where you're viewing your notebook to see your changes take effect.
174174

175175
Running automated tests
@@ -180,9 +180,9 @@ of the repository.
180180
Contributing
181181
------------
182182
All contributions, bug reports, bug fixes, documentation improvements, enhancements, and ideas are welcome. See the
183-
`Running from source & testing your changes`_ section above for more details on local modin-spreadsheet development.
183+
`Running from source & testing your changes`_ section above for more details on local Modin-spreadsheet development.
184184

185-
If you are looking to start working with the modin-spreadsheet codebase, navigate to the GitHub issues tab and start looking
185+
If you are looking to start working with the Modin-spreadsheet codebase, navigate to the GitHub issues tab and start looking
186186
through interesting issues.
187187

188188
Feel free to ask questions by submitting an issue with your question.

0 commit comments

Comments
 (0)