summaryrefslogtreecommitdiff
path: root/src/mailman/styles/docs
diff options
context:
space:
mode:
authorJ08nY2017-06-04 17:41:29 +0200
committerJ08nY2017-08-07 18:03:42 +0200
commite65f5e7bbb34063e252ffecd13fc349c5cb69a24 (patch)
treeb7cb079e8b0bd6c7f5312a38c59d22da68a7eae5 /src/mailman/styles/docs
parent324226f1f859f6be5e932dc9abe638aba268d154 (diff)
downloadmailman-e65f5e7bbb34063e252ffecd13fc349c5cb69a24.tar.gz
mailman-e65f5e7bbb34063e252ffecd13fc349c5cb69a24.tar.zst
mailman-e65f5e7bbb34063e252ffecd13fc349c5cb69a24.zip
Add description attribute to IStyle, expose it in REST.
Diffstat (limited to 'src/mailman/styles/docs')
-rw-r--r--src/mailman/styles/docs/styles.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/src/mailman/styles/docs/styles.rst b/src/mailman/styles/docs/styles.rst
index 270b0cdcc..a296bab54 100644
--- a/src/mailman/styles/docs/styles.rst
+++ b/src/mailman/styles/docs/styles.rst
@@ -49,6 +49,7 @@ New styles must implement the ``IStyle`` interface.
>>> @implementer(IStyle)
... class TestStyle:
... name = 'a-test-style'
+ ... description = 'Testing mailing list style.'
... def apply(self, mailing_list):
... # Just does something very simple.
... mailing_list.display_name = 'TEST STYLE LIST'
@@ -115,6 +116,7 @@ If no style name is provided when creating the list, the system default style
>>> @implementer(IStyle)
... class AnotherStyle:
... name = 'another-style'
+ ... description = 'Another testing mailing list style.'
... def apply(self, mailing_list):
... # Just does something very simple.
... mailing_list.display_name = 'ANOTHER STYLE LIST'