Clarify the usecase for an msisdn delegate (#8734)

TeFiLeDo · web-flow · commit f1de4bb58b5b · 2020-11-14T23:09:36.000Z
Signed-off-by: Adrian Wannenmacher &lt;tfld@tfld.dev&gt;
diff --git a/changelog.d/8734.doc b/changelog.d/8734.doc
@@ -0,0 +1 @@
+Clarify the usecase for an msisdn delegate. Contributed by Adrian Wannenmacher.
diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml
@@ -1230,8 +1230,9 @@ account_validity:
 # email will be globally disabled.
 #
 # Additionally, if `msisdn` is not set, registration and password resets via msisdn
-# will be disabled regardless. This is due to Synapse currently not supporting any
-# method of sending SMS messages on its own.
+# will be disabled regardless, and users will not be able to associate an msisdn
+# identifier to their account. This is due to Synapse currently not supporting
+# any method of sending SMS messages on its own.
 #
 # To enable using an identity server for operations regarding a particular third-party
 # identifier type, set the value to the URL of that identity server as shown in the
diff --git a/synapse/config/registration.py b/synapse/config/registration.py
@@ -347,8 +347,9 @@ def generate_config_section(self, generate_secrets=False, **kwargs):
         # email will be globally disabled.
         #
         # Additionally, if `msisdn` is not set, registration and password resets via msisdn
-        # will be disabled regardless. This is due to Synapse currently not supporting any
-        # method of sending SMS messages on its own.
+        # will be disabled regardless, and users will not be able to associate an msisdn
+        # identifier to their account. This is due to Synapse currently not supporting
+        # any method of sending SMS messages on its own.
         #
         # To enable using an identity server for operations regarding a particular third-party
         # identifier type, set the value to the URL of that identity server as shown in the

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Clarify the usecase for an msisdn delegate. Contributed by Adrian Wannenmacher.`
Original file line number	Diff line number	Diff line change
`@@ -1230,8 +1230,9 @@ account_validity:`
`1230`	`1230`	`# email will be globally disabled.`
`1231`	`1231`	`#`
`1232`	`1232`	# Additionally, if `msisdn` is not set, registration and password resets via msisdn
`1233`		`-# will be disabled regardless. This is due to Synapse currently not supporting any`
`1234`		`-# method of sending SMS messages on its own.`
	`1233`	`+# will be disabled regardless, and users will not be able to associate an msisdn`
	`1234`	`+# identifier to their account. This is due to Synapse currently not supporting`
	`1235`	`+# any method of sending SMS messages on its own.`
`1235`	`1236`	`#`
`1236`	`1237`	`# To enable using an identity server for operations regarding a particular third-party`
`1237`	`1238`	`# identifier type, set the value to the URL of that identity server as shown in the`
Original file line number	Diff line number	Diff line change
`@@ -347,8 +347,9 @@ def generate_config_section(self, generate_secrets=False, **kwargs):`
`347`	`347`	`# email will be globally disabled.`
`348`	`348`	`#`
`349`	`349`	# Additionally, if `msisdn` is not set, registration and password resets via msisdn
`350`		`- # will be disabled regardless. This is due to Synapse currently not supporting any`
`351`		`- # method of sending SMS messages on its own.`
	`350`	`+ # will be disabled regardless, and users will not be able to associate an msisdn`
	`351`	`+ # identifier to their account. This is due to Synapse currently not supporting`
	`352`	`+ # any method of sending SMS messages on its own.`
`352`	`353`	`#`
`353`	`354`	`# To enable using an identity server for operations regarding a particular third-party`
`354`	`355`	`# identifier type, set the value to the URL of that identity server as shown in the`