Skip to content

Commit fd677ae

Browse files
committed
Merge pull request #7484 from dstephens99/master
DOC: Clean up docs for io.data.Options.
2 parents 70baac7 + da93a8c commit fd677ae

File tree

3 files changed

+13
-16
lines changed

3 files changed

+13
-16
lines changed

doc/source/release.rst

-4
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,6 @@ performance improvements along with a large number of bug fixes.
5555

5656
Highlights include:
5757

58-
Experimental Features
59-
~~~~~~~~~~~~~~~~~~~~~
60-
- ``pandas.io.data.Options`` has a get_all_data method and now consistently returns a multi-indexed ''DataFrame'' (:issue:`5602`)
61-
6258
See the :ref:`v0.14.1 Whatsnew <whatsnew_0141>` overview or the issue tracker on GitHub for an extensive list
6359
of all API changes, enhancements and bugs that have been fixed in 0.14.1.
6460

doc/source/remote_data.rst

+9-9
Original file line numberDiff line numberDiff line change
@@ -60,22 +60,22 @@ Yahoo! Finance Options
6060

6161
The Options class allows the download of options data from Yahoo! Finance.
6262

63-
The ''get_all_data'' method downloads and caches option data for all expiry months
64-
and provides a formatted ''DataFrame'' with a hierarchical index, so its easy to get
63+
The ``get_all_data`` method downloads and caches option data for all expiry months
64+
and provides a formatted ``DataFrame`` with a hierarchical index, so its easy to get
6565
to the specific option you want.
6666

6767
.. ipython:: python
6868
6969
from pandas.io.data import Options
7070
aapl = Options('aapl', 'yahoo')
7171
data = aapl.get_all_data()
72-
data.head()
72+
data.iloc[0:5:, 0:5]
7373
74-
#Show the $600 strike puts at all expiry dates:
75-
data.loc[(600, slice(None), 'put'),:].head()
74+
#Show the $100 strike puts at all expiry dates:
75+
data.loc[(100, slice(None), 'put'),:].iloc[0:5:, 0:5]
7676
77-
#Show the volume traded of $600 strike puts at all expiry dates:
78-
data.loc[(600, slice(None), 'put'),'Vol'].head()
77+
#Show the volume traded of $100 strike puts at all expiry dates:
78+
data.loc[(100, slice(None), 'put'),'Vol'].iloc[0:5:, 0:5]
7979
8080
If you don't want to download all the data, more specific requests can be made.
8181

@@ -84,9 +84,9 @@ If you don't want to download all the data, more specific requests can be made.
8484
import datetime
8585
expiry = datetime.date(2016, 1, 1)
8686
data = aapl.get_call_data(expiry=expiry)
87-
data.head()
87+
data.iloc[0:5:, 0:5]
8888
89-
Note that if you call ''get_all_data'' first, this second call will happen much faster, as the data is cached.
89+
Note that if you call ``get_all_data`` first, this second call will happen much faster, as the data is cached.
9090

9191

9292
.. _remote_data.google:

doc/source/v0.14.1.txt

+4-3
Original file line numberDiff line numberDiff line change
@@ -148,22 +148,23 @@ Performance
148148
Experimental
149149
~~~~~~~~~~~~
150150

151-
``pandas.io.data.Options`` has a get_all_data method and now consistently returns a multi-indexed ''DataFrame'' (PR `#5602`)
151+
``pandas.io.data.Options`` has a get_all_data method and now consistently returns a multi-indexed ``DataFrame`` (PR `#5602`)
152152
See :ref:`the docs<remote_data.yahoo_Options>` ***Experimental***
153153

154154
.. ipython:: python
155155

156156
from pandas.io.data import Options
157157
aapl = Options('aapl', 'yahoo')
158158
data = aapl.get_all_data()
159-
data.head()
159+
data.iloc[0:5:, 0:5]
160+
160161

161162
.. ipython:: python
162163

163164
from pandas.io.data import Options
164165
aapl = Options('aapl', 'yahoo')
165166
data = aapl.get_all_data()
166-
data.head()
167+
data.iloc[0:5:, 0:5]
167168

168169

169170
.. _whatsnew_0141.bug_fixes:

0 commit comments

Comments
 (0)