Merge ~mthaddon/charm-k8s-ingress/+git/charm-k8s-ingress:docstrings into charm-k8s-ingress:master

[Tom Haddon]

Add docstrings and remove note referring to an individual in unit tests

Add docstrings and remove note referring to an individual in unit tests

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

A CI job is currently in progress. A follow up comment will be added when it completes.

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

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

[🤖 prod-jenkaas-is (prod-jenkaas-is)]

PASSED: Continuous integration, rev:e7f7b40b56d1e63a6b906d2cf85e0dc7c1ca849f
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/61/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/is/job/lp-charm-test/175/
    None: https://jenkins.canonical.com/is/job/lp-update-mp/705605/

Click here to trigger a rebuild:
https://jenkins.canonical.com/is/job/lp-charm-k8s-ingress-ci/61//rebuild

review: Approve (continuous-integration)

[Jon Seager (jnsgruk)]

LGTM

review: Approve

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

Change successfully merged at revision 03f3bab57865d795c3e2fd3739d56b359274ef3d

diff --git a/src/charm.py b/src/charm.py
index b3bf263..e2fb7fb 100755
--- a/src/charm.py
+++ b/src/charm.py
@@ -354,6 +354,7 @@ class NginxIngressCharm(CharmBase):
 
     @property
     def _all_config_or_relations(self):
+        """Get all configuration and relation data."""
         all_relations = self.model.relations["ingress"] or [None]
         multiple_rels = self._multiple_relations
         return [
@@ -363,10 +364,16 @@ class NginxIngressCharm(CharmBase):
 
     @property
     def _multiple_relations(self):
+        """Return a boolean indicating if we're related to multiple applications."""
         return len(self.model.relations["ingress"]) > 1
 
     @property
     def _namespace(self):
+        """Namespace for this ingress."""
+        # We're querying the first one here because this will always be the same
+        # for all instances. It would be very unusual for a relation to specify
+        # this (arguably we should remove this as a relation option), so if set
+        # via config it will be the same for all relations.
         return self._all_config_or_relations[0]._namespace
 
     def _describe_ingresses_action(self, event):
@@ -514,6 +521,7 @@ class NginxIngressCharm(CharmBase):
             self._define_ingress(ingress)
 
     def _process_ingresses(self, ingresses):
+        """Process ingresses, or raise an exception if there are unresolvable conflicts."""
         # If there are Ingress rules for the same service-hostname, we need to squash those
         # rules together. This will be used to group the rules by their host.
         ingress_paths = {}
diff --git a/tests/unit/test_charm.py b/tests/unit/test_charm.py
index d11634d..c4cc9cf 100644
--- a/tests/unit/test_charm.py
+++ b/tests/unit/test_charm.py
@@ -969,7 +969,7 @@ class TestCharmMultipleRelations(unittest.TestCase):
     def test_get_multiple_ingress_relation_data(self):
         """Test for getting our multiple ingress relation data."""
         # Confirm we don't have any relation data yet in the relevant properties
-        # NOTE(claudiub): _all_config_or_relations will always have at least one element.
+        # NOTE: _all_config_or_relations will always have at least one element.
         conf_or_rels = self.harness.charm._all_config_or_relations
         self.assertEqual(0, len(self.harness.charm.model.relations['ingress']))
         self.assertEqual(1, len(conf_or_rels))