mercurial/crew
changeset 9104:c9c5aa12a46e
notify: cleanup module docstring
| author | Martin Geisler <mg@lazybytes.net> |
|---|---|
| date | Thu Jul 09 22:42:43 2009 +0200 (7 months ago) |
| parents | 9c7a5d70e72f |
| children | 6188f2cc4a37 |
| files | hgext/notify.py tests/test-notify.out |
line diff
1.1 --- a/hgext/notify.py 1.2 +++ b/hgext/notify.py 1.3 @@ -7,10 +7,10 @@ 1.4 1.5 '''hooks for sending email notifications at commit/push time 1.6 1.7 -Subscriptions can be managed through hgrc. Default mode is to print messages 1.8 -to stdout, for testing and configuring. 1.9 +Subscriptions can be managed through a hgrc file. Default mode is to print 1.10 +messages to stdout, for testing and configuring. 1.11 1.12 -To use, configure notify extension and enable in hgrc like this: 1.13 +To use, configure the notify extension and enable it in hgrc like this: 1.14 1.15 [extensions] 1.16 hgext.notify = 1.17 @@ -22,14 +22,14 @@ 1.18 changegroup.notify = python:hgext.notify.hook 1.19 1.20 [notify] 1.21 - # config items go in here 1.22 + # config items go here 1.23 1.24 - config items: 1.25 + Required configuration items: 1.26 1.27 - REQUIRED: 1.28 config = /path/to/file # file containing subscriptions 1.29 1.30 - OPTIONAL: 1.31 + Optional configuration items: 1.32 + 1.33 test = True # print messages to stdout for testing 1.34 strip = 3 # number of slashes to strip for url paths 1.35 domain = example.com # domain to use if committer missing domain 1.36 @@ -47,8 +47,8 @@ 1.37 [web] 1.38 baseurl = http://hgserver/... # root of hg web site for browsing commits 1.39 1.40 - notify config file has same format as regular hgrc. it has two sections so 1.41 - you can express subscriptions in whatever way is handier for you. 1.42 + The notify config file has same format as a regular hgrc file. It has two 1.43 + sections so you can express subscriptions in whatever way is handier for you. 1.44 1.45 [usersubs] 1.46 # key is subscriber email, value is ","-separated list of glob patterns 1.47 @@ -58,9 +58,9 @@ 1.48 # key is glob pattern, value is ","-separated list of subscriber emails 1.49 pattern = user@host 1.50 1.51 - glob patterns are matched against path to repository root. 1.52 + Glob patterns are matched against path to repository root. 1.53 1.54 - if you like, you can put notify config file in repository that users can push 1.55 + If you like, you can put notify config file in repository that users can push 1.56 changes to, they can manage their own subscriptions. 1.57 ''' 1.58
2.1 --- a/tests/test-notify.out 2.2 +++ b/tests/test-notify.out 2.3 @@ -1,9 +1,9 @@ 2.4 notify extension - hooks for sending email notifications at commit/push time 2.5 2.6 -Subscriptions can be managed through hgrc. Default mode is to print messages 2.7 -to stdout, for testing and configuring. 2.8 +Subscriptions can be managed through a hgrc file. Default mode is to print 2.9 +messages to stdout, for testing and configuring. 2.10 2.11 -To use, configure notify extension and enable in hgrc like this: 2.12 +To use, configure the notify extension and enable it in hgrc like this: 2.13 2.14 [extensions] 2.15 hgext.notify = 2.16 @@ -15,14 +15,14 @@ 2.17 changegroup.notify = python:hgext.notify.hook 2.18 2.19 [notify] 2.20 - # config items go in here 2.21 + # config items go here 2.22 2.23 - config items: 2.24 + Required configuration items: 2.25 2.26 - REQUIRED: 2.27 config = /path/to/file # file containing subscriptions 2.28 2.29 - OPTIONAL: 2.30 + Optional configuration items: 2.31 + 2.32 test = True # print messages to stdout for testing 2.33 strip = 3 # number of slashes to strip for url paths 2.34 domain = example.com # domain to use if committer missing domain 2.35 @@ -40,8 +40,8 @@ 2.36 [web] 2.37 baseurl = http://hgserver/... # root of hg web site for browsing commits 2.38 2.39 - notify config file has same format as regular hgrc. it has two sections so 2.40 - you can express subscriptions in whatever way is handier for you. 2.41 + The notify config file has same format as a regular hgrc file. It has two 2.42 + sections so you can express subscriptions in whatever way is handier for you. 2.43 2.44 [usersubs] 2.45 # key is subscriber email, value is ","-separated list of glob patterns 2.46 @@ -51,9 +51,9 @@ 2.47 # key is glob pattern, value is ","-separated list of subscriber emails 2.48 pattern = user@host 2.49 2.50 - glob patterns are matched against path to repository root. 2.51 + Glob patterns are matched against path to repository root. 2.52 2.53 - if you like, you can put notify config file in repository that users can push 2.54 + If you like, you can put notify config file in repository that users can push 2.55 changes to, they can manage their own subscriptions. 2.56 2.57 no commands defined
