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.

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

Docs improvements #864

Merged
merged 8 commits into from Nov 19, 2015

Conversation

Projects
None yet
2 participants
@ssanderson
Member

ssanderson commented Nov 19, 2015

  • Generate links to sourcecode via the Sphinx viewcode extension.
  • Generate reference docs for Asset/Equity/Future, AssetFinder, and
    AssetDBWriter.
  • Generate reference docs for Pipeline API classes.
  • Fix broken links and formatting issues in the 0.8.4 whatsnew.
  • Use embedsignature in _assets.pyx so that the signatures of Asset
    subclasses are inspectable.
Zipline API
-----------
API Reference
-------------

This comment has been minimized.

@llllllllll

llllllllll Nov 19, 2015

Member

Looks like there is one extra _

edit: noticed this for the other underlines too

This comment has been minimized.

@ssanderson

ssanderson Nov 19, 2015

Member

I think GitHub is rendering incorrectly for you? These are all correct in source.

This comment has been minimized.

@llllllllll

llllllllll Nov 19, 2015

Member

weird, yeah

~~~~~~~~~~~~~

The following methods are available for use in the ``initialize``,
``handle_data`` and ``before_trading_start`` API functions.

This comment has been minimized.

@llllllllll

This comment has been minimized.

@ssanderson

ssanderson Nov 19, 2015

Member

There are raging debates over whether or not it's correct to put a comma here: http://www.oxforddictionaries.com/us/words/what-is-the-oxford-comma.

This comment has been minimized.

@ssanderson

ssanderson Nov 19, 2015

Member

(That said, I generally fall on the pro-comma side of said debates, so I'll add one.)

ssanderson added some commits Nov 19, 2015

DOC: Many docs improvements.
- Generate links to sourcecode via the Sphinx `viewcode` extension.
- Generate reference docs for Asset/Equity/Future, AssetFinder, and
  AssetDBWriter.
- Generate reference docs for Pipeline API classes.
- Fix broken links and formatting issues in the 0.8.4 whatsnew.
- Use embedsignature in _assets.pyx so that the signatures of Asset
  subclasses are inspectable.

@ssanderson ssanderson force-pushed the docs-improvements branch from ec4b676 to e812a1c Nov 19, 2015

`AssetFinderCachedEquities`, that loads equities into dictionaries and
then directs `lookup_symbol` to these dictionaries to find matching equities
(:issue:`830`).
.. py:currentmodule:: zipline.assets.assets

This comment has been minimized.

@llllllllll

llllllllll Nov 19, 2015

Member

just use the full path, this is stateful and someone later in the file might not know to reset this.

@@ -1,3 +1,4 @@
# cython: embedsignature=True

This comment has been minimized.

@llllllllll

llllllllll Nov 19, 2015

Member

what does this pragma do?

This comment has been minimized.

@ssanderson

ssanderson Nov 19, 2015

Member

This makes Cython include the signature as a string in the generated C source so that inspection tools (e.g. sphinx, or IPython) can examine it).

This comment has been minimized.

@llllllllll

llllllllll Nov 19, 2015

Member

oh, it uses the __text_signatue__ or something?

# Token used as a substitute for pickling objects that contain a
# reference to an AssetFinder
# reference to an AssetFinderA d

This comment has been minimized.

@llllllllll

llllllllll Nov 19, 2015

Member

cleanup

ssanderson added a commit that referenced this pull request Nov 19, 2015

@ssanderson ssanderson merged commit 85a95ea into master Nov 19, 2015

0 of 2 checks passed

Scrutinizer Running Analyses
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

@ssanderson ssanderson deleted the docs-improvements branch Nov 19, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment