summary refs log tree commit diff
path: root/synapse/appservice/__init__.py
diff options
context:
space:
mode:
authorLuke Barnard <luke@matrix.org>2017-11-16 18:03:46 +0000
committerLuke Barnard <luke@matrix.org>2017-11-16 18:03:46 +0000
commit4e8374856d6611980c676e355eaf4de464ec312e (patch)
tree0fa336eb91203955643a054d3cb8b38b62d4596e /synapse/appservice/__init__.py
parentFlake8 (diff)
downloadsynapse-4e8374856d6611980c676e355eaf4de464ec312e.tar.xz
Document get_groups_for_user
Diffstat (limited to 'synapse/appservice/__init__.py')
-rw-r--r--synapse/appservice/__init__.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/synapse/appservice/__init__.py b/synapse/appservice/__init__.py
index 916ccf714a..e49452532d 100644
--- a/synapse/appservice/__init__.py
+++ b/synapse/appservice/__init__.py
@@ -274,6 +274,12 @@ class ApplicationService(object):
 
     def get_groups_for_user(self, user_id):
         """Get the groups that this user is associated with by this AS
+
+        Args:
+            user_id (str): The ID of the user.
+
+        Returns:
+            iterable[str]: an iterable that yields group_id strings.
         """
         return (
             regex_obj["group_id"]