coursera-dl / edx-dl

51%

master: 48%

LAST BUILD ON BRANCH use-comments-as-docstring

branch: use-comments-as-docstring

CHANGE BRANCH

x

Reset

• use-comments-as-docstring
• 0.1.10
• 0.1.2
• 0.1.3
• 0.1.5
• 0.1.6
• 0.1.7
• 0.1.8
• 0.1.9
• fix-0-courses-available
• master
• new-python-in-travis
• set-travis-notifications
• use-external-downloader

Build # 23

Build Type

push

travis-ci

Committed by rbrito

Commit Message

edx_dl/common: Use comments on the classes as the module docstring.

The huge comment that we have is better if it is made part of the docstring
of the module, as that is informative when using pydoc (or any other kind of
documentation browser that one wishes to use).

In fact, I would argue that it is even going to be nice to have it become
"part of our API" (for the lack of a better term), as I believe that it will
bring us more flexibility.

Signed-off-by: Rogério Brito <rbrito@ime.usp.br>

Run Details

319 of 623 relevant lines covered (51.2%)

2.05 hits per line