Skip to content

DOC: Clean up docs for io.data.Options. #7484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 17, 2014
Merged

DOC: Clean up docs for io.data.Options. #7484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions doc/source/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,6 @@ performance improvements along with a large number of bug fixes.

Highlights include:

Experimental Features
~~~~~~~~~~~~~~~~~~~~~
- ``pandas.io.data.Options`` has a get_all_data method and now consistently returns a multi-indexed ''DataFrame'' (:issue:`5602`)

See the :ref:`v0.14.1 Whatsnew <whatsnew_0141>` overview or the issue tracker on GitHub for an extensive list
of all API changes, enhancements and bugs that have been fixed in 0.14.1.

Expand Down
18 changes: 9 additions & 9 deletions doc/source/remote_data.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,22 +60,22 @@ Yahoo! Finance Options

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

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

.. ipython:: python

from pandas.io.data import Options
aapl = Options('aapl', 'yahoo')
data = aapl.get_all_data()
data.head()
data.iloc[0:5:, 0:5]

#Show the $600 strike puts at all expiry dates:
data.loc[(600, slice(None), 'put'),:].head()
#Show the $100 strike puts at all expiry dates:
data.loc[(100, slice(None), 'put'),:].iloc[0:5:, 0:5]

#Show the volume traded of $600 strike puts at all expiry dates:
data.loc[(600, slice(None), 'put'),'Vol'].head()
#Show the volume traded of $100 strike puts at all expiry dates:
data.loc[(100, slice(None), 'put'),'Vol'].iloc[0:5:, 0:5]

If you don't want to download all the data, more specific requests can be made.

Expand All @@ -84,9 +84,9 @@ If you don't want to download all the data, more specific requests can be made.
import datetime
expiry = datetime.date(2016, 1, 1)
data = aapl.get_call_data(expiry=expiry)
data.head()
data.iloc[0:5:, 0:5]

Note that if you call ''get_all_data'' first, this second call will happen much faster, as the data is cached.
Note that if you call ``get_all_data`` first, this second call will happen much faster, as the data is cached.


.. _remote_data.google:
Expand Down
7 changes: 4 additions & 3 deletions doc/source/v0.14.1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,22 +148,23 @@ Performance
Experimental
~~~~~~~~~~~~

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

.. ipython:: python

from pandas.io.data import Options
aapl = Options('aapl', 'yahoo')
data = aapl.get_all_data()
data.head()
data.iloc[0:5:, 0:5]


.. ipython:: python

from pandas.io.data import Options
aapl = Options('aapl', 'yahoo')
data = aapl.get_all_data()
data.head()
data.iloc[0:5:, 0:5]


.. _whatsnew_0141.bug_fixes:
Expand Down