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.

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

Improved docs #147

Merged
merged 13 commits into from
Dec 10, 2013
Merged

Improved docs #147

merged 13 commits into from
Dec 10, 2013

Conversation

nedbat
Copy link
Contributor

@nedbat nedbat commented Dec 10, 2013

A number of changes to the docs and docstrings, generally skimming through and cleaning up, modernizing, bringing up-to-date with the code, etc.

@nedbat
Copy link
Contributor Author

nedbat commented Dec 10, 2013

@cpennington it would be good to have these on rtfd.org for tomorrow.

@mhoeber Not sure if you want to chime in on any aspect of this, maybe you want to at least see the kind of changes I'm making.

$ cd ~
$ mkdir edxwork
$ cd edxwork
$ /path/to/XBlock/script/startnew.py
Copy link
Contributor

Choose a reason for hiding this comment

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

Not for this PR, but we should use the console_scripts entry point to just install the startnew script into the virtualenv when you install xblocks. That way, in the future, you'll just be able to pip install XBlock && start_xblock, or something similar.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why didn't I think of that!!? :)

@cpennington
Copy link
Contributor

👍

@mhoeber
Copy link
Contributor

mhoeber commented Dec 10, 2013

Thanks @nedbat I'm a little late but if you want me to do specific tasks by datajam, let me know. I have some time this afternoon and evening.

I can also deal with the RTD part. However, edX account currently doesn't have admin for XBlock project.

My goal is that starting in January when Alison starts is that any tasks like this can be assigned to me. We can talk in detail next week

nedbat added a commit that referenced this pull request Dec 10, 2013
@nedbat nedbat merged commit 5c49008 into master Dec 10, 2013
@nedbat
Copy link
Contributor Author

nedbat commented Dec 10, 2013

@mhoeboer thanks. I have the docs on rtfd.org already (XBlock was the first open source from edX). I'm not looking for you to do anything by the datajam, just wanted to get in the habit of keeping you in the loop at least.

@nedbat nedbat deleted the ned/improved-docs branch June 11, 2014 15:49
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