Merge lp://staging/~javier.collado/checkbox-core/shadowd-docstrings into lp://staging/checkbox-core
Proposed by
Javier Collado
| Status: | Merged |
|---|---|
| Merged at revision: | 20 |
| Proposed branch: | lp://staging/~javier.collado/checkbox-core/shadowd-docstrings |
| Merge into: | lp://staging/checkbox-core |
| Diff against target: |
77 lines (+29/-0) 5 files modified
checkbox/shadowd/__init__.py (+13/-0) checkbox/shadowd/client.py (+4/-0) checkbox/shadowd/operation.py (+4/-0) checkbox/shadowd/queue.py (+4/-0) checkbox/shadowd/sender.py (+4/-0) |
| To merge this branch: | bzr merge lp://staging/~javier.collado/checkbox-core/shadowd-docstrings |
| Related bugs: |
| Reviewer | Review Type | Date Requested | Status |
|---|---|---|---|
| Marc Tardif | Approve | ||
|
Review via email:
|
|||
Description of the change
A few docstrings have been added for the shadowd package and its modules.
To post a comment you must log in.
Revision history for this message
| Javier Collado (javier.collado) wrote | # |
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
I like how you once said that the docstring for a Python package or module should explain why it is there. It looks like the docstring in the checkbox.shadowd package tries to explain what it is doing, which would probably be better served by documentation under the doc/ directory. How would you feel about only keeping the first paragraph in that docstring?