Skip to content

Update docstrings, doctests, tutorial, & implementations to new interface#189

Merged
SamLau95 merged 16 commits intomasterfrom
docs
Feb 1, 2016
Merged

Update docstrings, doctests, tutorial, & implementations to new interface#189
SamLau95 merged 16 commits intomasterfrom
docs

Conversation

@papajohn
Copy link
Contributor

@papajohn papajohn commented Feb 1, 2016

TODO

  • Resolve some warnings/errors when running make docs

@papajohn
Copy link
Contributor Author

papajohn commented Feb 1, 2016

I still need to fix some errors with the docs generation, but wanted to give you a preview of a change I'd like to push soon. I believe it makes the docs & such coherent with the changes checked in last Friday for v0.5.0.

Copy link
Contributor

Choose a reason for hiding this comment

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

Did you mean to delete these lines?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

@papajohn
Copy link
Contributor Author

papajohn commented Feb 1, 2016

Ok, I've fixed the tutorial. I flipped through some of the generated HTML docs, and they looked fine too me. Anything else we need to clean up to keep the code base and docs consistent? I didn't update the tests to the new interface because I'd like to make sure we still support the deprecated interface as well for a while, so that connector instructors don't get too surprised.

Also, @SamLau95 can you redeploy the docs after we merge, because I don't yet know how to do that? Thanks!

@SamLau95
Copy link
Contributor

SamLau95 commented Feb 1, 2016

Looks good to me!

The docs should auto-push to the master branch of RTD after a merge: http://datascience.readthedocs.org/en/master/

I'll double check after the merge goes through.

SamLau95 added a commit that referenced this pull request Feb 1, 2016
Update docstrings, doctests, tutorial, & implementations to new interface
@SamLau95 SamLau95 merged commit 1218ea2 into master Feb 1, 2016
@SamLau95 SamLau95 deleted the docs branch February 1, 2016 06:10
@papajohn
Copy link
Contributor Author

papajohn commented Feb 1, 2016

Great. Want to deploy to {data8,ds8}.berkeley.edu as well? Thanks.

On Sun, Jan 31, 2016 at 10:10 PM, Sam Lau notifications@github.com wrote:

Merged #189 #189.


Reply to this email directly or view it on GitHub
#189 (comment).

@SamLau95
Copy link
Contributor

SamLau95 commented Feb 1, 2016

Sure thing.

@ryanlovett
Copy link
Contributor

Updated to 0.5.1 on both.

@SamLau95
Copy link
Contributor

SamLau95 commented Feb 1, 2016

Beat me to it. Thanks Ryan.

On Sun, Jan 31, 2016 at 11:08 PM, Ryan Lovett notifications@github.com
wrote:

Updated to 0.5.1 on both.


Reply to this email directly or view it on GitHub
#189 (comment).

Sam Lau
EECS | UC Berkeley | May 2017
(562) 565-4336 | samlau95@berkeley.edu

@ryanlovett
Copy link
Contributor

No problem.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants