wildly inconsistent docstring style (ensemble.providers)
Bug #831805 reported by
William Reade
This bug affects 1 person
| Affects | Status | Importance | Assigned to | Milestone | |
|---|---|---|---|---|---|
| pyjuju |
Fix Released
|
Undecided
|
William Reade | ||
Bug Description
Rather than enumerating all the different styles sprinkled through the project, I follow hazmat's suggestion that we write docstrings as follows:
Sphinx parameters
http://
Using the autodoc extension to extract docs from source code.
http://
Related branches
lp:~fwereade/pyjuju/fix-docstrings
- Jim Baker (community): Approve
- Gustavo Niemeyer: Approve
-
Diff: 1294 lines (+547/-171)25 files modified.bzrignore (+1/-0)
docs/Makefile (+2/-1)
docs/source/conf.py (+6/-3)
docs/source/generate_modules.py (+107/-0)
docs/source/index.rst (+1/-0)
ensemble/providers/__init__.py (+1/-0)
ensemble/providers/common/__init__.py (+1/-0)
ensemble/providers/common/base.py (+67/-41)
ensemble/providers/common/bootstrap.py (+4/-2)
ensemble/providers/common/cloudinit.py (+68/-0)
ensemble/providers/common/connect.py (+10/-7)
ensemble/providers/common/findzookeepers.py (+10/-0)
ensemble/providers/common/launch.py (+32/-15)
ensemble/providers/common/state.py (+18/-0)
ensemble/providers/common/utils.py (+27/-25)
ensemble/providers/ec2/__init__.py (+32/-14)
ensemble/providers/ec2/files.py (+21/-16)
ensemble/providers/ec2/launch.py (+12/-8)
ensemble/providers/ec2/machine.py (+6/-0)
ensemble/providers/ec2/utils.py (+10/-0)
ensemble/providers/orchestra/__init__.py (+28/-13)
ensemble/providers/orchestra/cobbler.py (+36/-14)
ensemble/providers/orchestra/files.py (+25/-0)
ensemble/providers/orchestra/launch.py (+14/-9)
ensemble/providers/orchestra/machine.py (+8/-3)
| description: | updated |
| Changed in ensemble: | |
| assignee: | nobody → William Reade (fwereade) |
| status: | New → In Progress |
| Changed in ensemble: | |
| milestone: | none → eureka |
| description: | updated |
| summary: |
- wildly inconsistent docstring style + wildly inconsistent docstring style (ensemble.providers) |
| Changed in ensemble: | |
| status: | In Progress → Fix Released |
To post a comment you must log in.
