Merge lp:~tvansteenburgh/charm-helpers/doc-updates into lp:charm-helpers

Proposed by Tim Van Steenburgh
Status: Merged
Merged at revision: 192
Proposed branch: lp:~tvansteenburgh/charm-helpers/doc-updates
Merge into: lp:charm-helpers
Diff against target: 104 lines (+17/-21)
6 files modified
charmhelpers/core/services/base.py (+2/-2)
charmhelpers/core/services/helpers.py (+1/-1)
docs/api/charmhelpers.contrib.jujugui.rst (+0/-16)
docs/api/charmhelpers.contrib.rst (+0/-1)
docs/api/charmhelpers.core.rst (+14/-0)
setup.py (+0/-1)
To merge this branch: bzr merge lp:~tvansteenburgh/charm-helpers/doc-updates
Reviewer Review Type Date Requested Status
Charles Butler (community) Approve
Review via email: mp+229696@code.launchpad.net

Description of the change

Update docs to match recent branches:

- Removed references to jujugui
- Added core.services docs

To post a comment you must log in.
Revision history for this message
Charles Butler (lazypower) wrote :

+1 LGTM

Revision history for this message
Charles Butler (lazypower) :
review: Approve

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== modified file 'charmhelpers/core/services/base.py'
--- charmhelpers/core/services/base.py 2014-08-05 13:02:58 +0000
+++ charmhelpers/core/services/base.py 2014-08-05 21:31:00 +0000
@@ -26,7 +26,7 @@
26 setup tasks, in the most declarative way possible.26 setup tasks, in the most declarative way possible.
2727
28 Service definitions are dicts in the following formats (all keys except28 Service definitions are dicts in the following formats (all keys except
29 'service' are optional):29 'service' are optional)::
3030
31 {31 {
32 "service": <service name>,32 "service": <service name>,
@@ -79,7 +79,7 @@
7979
80 The following registers an Upstart service called bingod that depends on80 The following registers an Upstart service called bingod that depends on
81 a mongodb relation and which runs a custom `db_migrate` function prior to81 a mongodb relation and which runs a custom `db_migrate` function prior to
82 restarting the service, and a Runit service called spadesd.82 restarting the service, and a Runit service called spadesd::
8383
84 manager = services.ServiceManager([84 manager = services.ServiceManager([
85 {85 {
8686
=== modified file 'charmhelpers/core/services/helpers.py'
--- charmhelpers/core/services/helpers.py 2014-08-05 13:02:58 +0000
+++ charmhelpers/core/services/helpers.py 2014-08-05 21:31:00 +0000
@@ -73,7 +73,7 @@
73 If you only care about a single unit on the relation, you can just73 If you only care about a single unit on the relation, you can just
74 access it as `{{ interface[0]['key'] }}`. However, if you can at all74 access it as `{{ interface[0]['key'] }}`. However, if you can at all
75 support multiple units on a relation, you should iterate over the list,75 support multiple units on a relation, you should iterate over the list,
76 like:76 like::
7777
78 {% for unit in interface -%}78 {% for unit in interface -%}
79 {{ unit['key'] }}{% if not loop.last %},{% endif %}79 {{ unit['key'] }}{% if not loop.last %},{% endif %}
8080
=== removed file 'docs/api/charmhelpers.contrib.jujugui.rst'
--- docs/api/charmhelpers.contrib.jujugui.rst 2014-06-09 14:56:35 +0000
+++ docs/api/charmhelpers.contrib.jujugui.rst 1970-01-01 00:00:00 +0000
@@ -1,16 +0,0 @@
1charmhelpers.contrib.jujugui package
2====================================
3
4charmhelpers.contrib.jujugui.utils module
5-----------------------------------------
6
7.. automodule:: charmhelpers.contrib.jujugui.utils
8 :members:
9 :undoc-members:
10 :show-inheritance:
11
12
13.. automodule:: charmhelpers.contrib.jujugui
14 :members:
15 :undoc-members:
16 :show-inheritance:
170
=== modified file 'docs/api/charmhelpers.contrib.rst'
--- docs/api/charmhelpers.contrib.rst 2014-06-09 14:56:35 +0000
+++ docs/api/charmhelpers.contrib.rst 2014-08-05 21:31:00 +0000
@@ -7,7 +7,6 @@
7 charmhelpers.contrib.charmhelpers7 charmhelpers.contrib.charmhelpers
8 charmhelpers.contrib.charmsupport8 charmhelpers.contrib.charmsupport
9 charmhelpers.contrib.hahelpers9 charmhelpers.contrib.hahelpers
10 charmhelpers.contrib.jujugui
11 charmhelpers.contrib.network10 charmhelpers.contrib.network
12 charmhelpers.contrib.openstack11 charmhelpers.contrib.openstack
13 charmhelpers.contrib.peerstorage12 charmhelpers.contrib.peerstorage
1413
=== modified file 'docs/api/charmhelpers.core.rst'
--- docs/api/charmhelpers.core.rst 2014-06-09 14:56:35 +0000
+++ docs/api/charmhelpers.core.rst 2014-08-05 21:31:00 +0000
@@ -25,6 +25,20 @@
25 :undoc-members:25 :undoc-members:
26 :show-inheritance:26 :show-inheritance:
2727
28charmhelpers.core.services package
29----------------------------------
30
31.. automodule:: charmhelpers.core.services.base
32 :members:
33 :undoc-members:
34 :show-inheritance:
35 :special-members: __init__
36
37.. automodule:: charmhelpers.core.services.helpers
38 :members:
39 :undoc-members:
40 :show-inheritance:
41
2842
29.. automodule:: charmhelpers.core43.. automodule:: charmhelpers.core
30 :members:44 :members:
3145
=== modified file 'setup.py'
--- setup.py 2014-06-09 15:23:32 +0000
+++ setup.py 2014-08-05 21:31:00 +0000
@@ -26,7 +26,6 @@
26 "charmhelpers.contrib.charmsupport",26 "charmhelpers.contrib.charmsupport",
27 "charmhelpers.contrib.saltstack",27 "charmhelpers.contrib.saltstack",
28 "charmhelpers.contrib.hahelpers",28 "charmhelpers.contrib.hahelpers",
29 "charmhelpers.contrib.jujugui",
30 "charmhelpers.contrib.templating",29 "charmhelpers.contrib.templating",
31 ],30 ],
32 'scripts': [31 'scripts': [

Subscribers

People subscribed via source and target branches