Merge ~barryprice/charm-k8s-bind/+git/charm-k8s-bind:docstrings into charm-k8s-bind:master

[Barry Price]

Add missing docstrings, remove a useless method that only ever called another one

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[Tom Haddon (mthaddon)]

LGTM, thx

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 56b7767a928d4277efd177046867e299d398b75c

diff --git a/src/charm.py b/src/charm.py
index 8754cfa..913f69f 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -18,6 +18,7 @@ REQUIRED_SETTINGS = ['bind_image_path']
 
 class BindK8sCharm(CharmBase):
     def __init__(self, *args):
+        """Initialise our class, we only care about 'start' and 'config-changed' hooks."""
         super().__init__(*args)
         self.framework.observe(self.on.start, self.on_config_changed)
         self.framework.observe(self.on.config_changed, self.on_config_changed)
@@ -47,11 +48,9 @@ class BindK8sCharm(CharmBase):
         return sorted(list(set(missing)))
 
     def on_config_changed(self, event):
-        self.configure_pod()
-
-    def configure_pod(self):
-        # Only the leader can set_spec().
+        """Check that we're leader, and if so, set up the pod."""
         if self.model.unit.is_leader():
+            # Only the leader can set_spec().
             resources = self.make_pod_resources()
             spec = self.make_pod_spec()
             spec.update(resources)
@@ -69,7 +68,8 @@ class BindK8sCharm(CharmBase):
             self.model.unit.status = ActiveStatus()
 
     def make_pod_resources(self):
-        """LP#1889746: We should define a manual ingress here to work around LP#1889703."""
+        """Compile and return our pod resources (e.g. ingresses)."""
+        # LP#1889746: We need to define a manual ingress here to work around LP#1889703.
         resources = {}  # TODO
         out = io.StringIO()
         pprint(resources, out)
@@ -107,6 +107,7 @@ class BindK8sCharm(CharmBase):
         return pod_config
 
     def make_pod_spec(self):
+        """Set up and return our full pod spec here."""
         config = self.model.config
         full_pod_config = self.generate_pod_config(secured=False)
         secure_pod_config = self.generate_pod_config(secured=True)