changeset 2923:8c2d3c474fc6

doc: make paragraphs before example code end with "::" for reST syntax This prevents lines in an example code from being treated as a part of normal paragraph. For issue example, lines are folded into one paragraph.
author FUJIWARA Katsunori <foozy@lares.dti.ne.jp>
date Mon, 07 Aug 2017 23:24:57 +0900
parents 66357d4d03b2
children 430fb1758d28
files hgext3rd/evolve/__init__.py hgext3rd/evolve/cmdrewrite.py hgext3rd/topic/__init__.py tests/test-topic.t
diffstat 4 files changed, 34 insertions(+), 22 deletions(-) [+]
line wrap: on
line diff
--- a/hgext3rd/evolve/__init__.py	Sun Sep 10 22:41:54 2017 +0900
+++ b/hgext3rd/evolve/__init__.py	Mon Aug 07 23:24:57 2017 +0900
@@ -34,7 +34,7 @@
 help people transitioning. (The extensions is currently compatible down to
 Mercurial version 3.8).
 
-New Config:
+New Config::
 
     [experimental]
     # Set to control the behavior when pushing draft changesets to a publishing
@@ -103,7 +103,7 @@
 
 For very large repositories. it is currently recommended to disable obsmarkers
 discovery (Make sure you follow release announcement to know when you can turn
-it back on).
+it back on)::
 
     [experimental]
     evolution.obsdiscovery = no
@@ -137,7 +137,7 @@
   # evolution.effect-flags = false
 
 You can display the effect flags with the command obslog, so if you have a
-changeset and you update only the message, you will see:
+changeset and you update only the message, you will see::
 
     $ hg commit -m "WIP
     $ hg commit -m "A better commit message!"
--- a/hgext3rd/evolve/cmdrewrite.py	Sun Sep 10 22:41:54 2017 +0900
+++ b/hgext3rd/evolve/cmdrewrite.py	Mon Aug 07 23:24:57 2017 +0900
@@ -350,7 +350,7 @@
 
          hg fold --from 3::6
 
-     - Fold revisions 3 and 4:
+     - Fold revisions 3 and 4::
 
         hg fold "3 + 4" --exact
 
--- a/hgext3rd/topic/__init__.py	Sun Sep 10 22:41:54 2017 +0900
+++ b/hgext3rd/topic/__init__.py	Mon Aug 07 23:24:57 2017 +0900
@@ -320,23 +320,29 @@
 def topics(ui, repo, topic=None, clear=False, rev=None, list=False, **opts):
     """View current topic, set current topic, change topic for a set of revisions, or see all topics.
 
-    Clear topic on existing topiced revisions:
-        `hg topic --rev <related revset> --clear`
+    Clear topic on existing topiced revisions::
+
+      hg topic --rev <related revset> --clear
+
+    Change topic on some revisions::
 
-    Change topic on some revisions:
-        `hg topic <newtopicname> --rev <related revset>`
+      hg topic <newtopicname> --rev <related revset>
 
-    Clear current topic:
-        `hg topic --clear`
+    Clear current topic::
+
+      hg topic --clear
 
-    Set current topic:
-        `hg topic <topicname>`
+    Set current topic::
+
+      hg topic <topicname>
+
+    List of topics::
 
-    List of topics:
-        `hg topics`
+      hg topics
 
-    List of topics with their last touched time sorted according to it:
-        `hg topic --age`
+    List of topics with their last touched time sorted according to it::
+
+      hg topic --age
 
     The active topic (if any) will be prepended with a "*".
 
--- a/tests/test-topic.t	Sun Sep 10 22:41:54 2017 +0900
+++ b/tests/test-topic.t	Mon Aug 07 23:24:57 2017 +0900
@@ -19,22 +19,28 @@
   see all topics.
   
       Clear topic on existing topiced revisions:
-          'hg topic --rev <related revset> --clear'
+  
+        hg topic --rev <related revset> --clear
   
       Change topic on some revisions:
-          'hg topic <newtopicname> --rev <related revset>'
+  
+        hg topic <newtopicname> --rev <related revset>
   
       Clear current topic:
-          'hg topic --clear'
+  
+        hg topic --clear
   
       Set current topic:
-          'hg topic <topicname>'
+  
+        hg topic <topicname>
   
       List of topics:
-          'hg topics'
+  
+        hg topics
   
       List of topics with their last touched time sorted according to it:
-          'hg topic --age'
+  
+        hg topic --age
   
       The active topic (if any) will be prepended with a "*".