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

Add engine docs #1826

Merged
merged 7 commits into from Jun 6, 2017

Conversation

Projects
None yet
3 participants
@ahgnaw
Contributor

ahgnaw commented Jun 5, 2017

This pr fixes several typos in docstrings that specify non-existent sphinx sections. For example Usage and Example have been converted to Examples. Note has been converted to Notes. Returns: has been converted to Returns. Several minor fixes, for example if there are not enough formatting ~ under a title.

Create a Pipeline subsection for built-in factors. The factors have been organized alphabetically.

Include Factor methods such as winsorize in documentation. Currently only some are listed and they are all useful to users.

Include documentation and subsection for PipelineEngine.

Two non-existent classes have been removed zipline.assets.AssetFinderCachedEquities and zipline.pipeline.data.EarningsCalendar.

@coveralls

This comment has been minimized.

coveralls commented Jun 5, 2017

Coverage Status

Coverage remained the same at 87.75% when pulling bb74a0e on add-engine-docs into cabe0b6 on master.

@ehebert

ehebert approved these changes Jun 6, 2017

LGTM, thanks!

@ahgnaw ahgnaw merged commit 1e28743 into master Jun 6, 2017

2 checks passed

continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details

@ahgnaw ahgnaw deleted the add-engine-docs branch Jun 6, 2017

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