topic: use preformatted block for config snippets documentation stable
authorDenis Laxalde <denis.laxalde@logilab.fr>
Wed, 23 May 2018 11:00:11 +0200
branchstable
changeset 3764 f0f9139016d8
parent 3763 6f56ff701746
child 3765 4aabc5c8b2af
topic: use preformatted block for config snippets documentation We add :: markers, empty line and properly indent blocks where needed.
hgext3rd/topic/__init__.py
tests/test-topic.t
--- a/hgext3rd/topic/__init__.py	Wed May 23 11:09:37 2018 +0200
+++ b/hgext3rd/topic/__init__.py	Wed May 23 11:00:11 2018 +0200
@@ -70,6 +70,8 @@
 The extensions come with an option to enforce that there is only one heads for
 each name in the repository at any time.
 
+::
+
     [experimental]
     enforce-single-head = yes
 
@@ -80,19 +82,22 @@
 phase usually happens on push, but it is possible to update that behavior. The
 server needs to have specific config for this.
 
-    # everything pushed become public (the default)
-    [phase]
-    publish = yes
+    # everything pushed become public (the default)::
+
+        [phase]
+        publish = yes
+
+    # nothing push turned public::
 
-    # nothing push turned public
-    [phase]
-    publish = no
+        [phase]
+        publish = no
+
+    # topic branches are not published, changeset without topic are::
 
-    # topic branches are not published, changeset without topic are
-    [phase]
-    publish = no
-    [experimental]
-    topic.publish-bare-branch = yes
+        [phase]
+        publish = no
+        [experimental]
+        topic.publish-bare-branch = yes
 
 In addition, the topic extension adds a ``--publish`` flag on :hg:`push`. When
 used, the pushed revisions are published if the push succeeds. It also applies
--- a/tests/test-topic.t	Wed May 23 11:09:37 2018 +0200
+++ b/tests/test-topic.t	Wed May 23 11:00:11 2018 +0200
@@ -82,7 +82,8 @@
   The extensions come with an option to enforce that there is only one heads for
   each name in the repository at any time.
   
-      [experimental] enforce-single-head = yes
+    [experimental]
+    enforce-single-head = yes
   
   Publishing behavior
   ===================
@@ -91,12 +92,22 @@
   phase usually happens on push, but it is possible to update that behavior. The
   server needs to have specific config for this.
   
-      # everything pushed become public (the default) [phase] publish = yes
+      # everything pushed become public (the default):
+  
+        [phase]
+        publish = yes
+  
+      # nothing push turned public:
   
-      # nothing push turned public [phase] publish = no
+        [phase]
+        publish = no
+  
+      # topic branches are not published, changeset without topic are:
   
-      # topic branches are not published, changeset without topic are [phase]
-      publish = no [experimental] topic.publish-bare-branch = yes
+        [phase]
+        publish = no
+        [experimental]
+        topic.publish-bare-branch = yes
   
   In addition, the topic extension adds a "--publish" flag on 'hg push'. When
   used, the pushed revisions are published if the push succeeds. It also applies