Skip to content
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

Jump to bottom

api documentation #1188

Merged
merged 3 commits into from
May 13, 2016
Merged

api documentation #1188

merged 3 commits into from
May 13, 2016

Conversation

llllllllll
Copy link
Contributor

Update the documentation for the zipline.api namespace as well as some supporting objects.

richafrank
richafrank reviewed May 9, 2016
View reviewed changes
docs/source/release-process.rst
The docs should always be built with **Python 3**. Many of our api functions
are wrapped by preprocessing functions which accept \*args and \**kwargs. In
Python 3, sphinx will respect the ``__wrapped__`` attribute and display the
correct arguments.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@coveralls
Copy link

coveralls commented May 12, 2016 •
edited
Loading

Coverage Status

Coverage decreased (-0.02%) to 81.452% when pulling 8622993 on api-docstrings into 8fdbfb8 on master.

@llllllllll llllllllll merged commit 19c87fd into master May 13, 2016
@llllllllll llllllllll deleted the api-docstrings branch May 13, 2016 02:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@richafrank richafrank

Labels
Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@llllllllll @coveralls @richafrank