Browse Source

Fix missing comment from previous change

In a previous commit [0] there was an additional character
escaping added at the end that was not added to the list
in the comment for the function. This change adds the missing
character to the list of escaped characters from the previous
change.

[0] https://review.openstack.org/#/c/439897/

Change-Id: I6e83a10ee51f1f18176bf2d17a0092d5a3cc4dd4
tags/3.0.1
Gage Hugo 2 years ago
parent
commit
2cf1d2eb18
1 changed files with 4 additions and 5 deletions
  1. 4
    5
      pbr/git.py

+ 4
- 5
pbr/git.py View File

@@ -146,15 +146,14 @@ def get_git_short_sha(git_dir=None):
146 146
 def _clean_changelog_message(msg):
147 147
     """Cleans any instances of invalid sphinx wording.
148 148
 
149
-    This removes any instances of invalid characters or wording
149
+    This escapes/removes any instances of invalid characters
150 150
     that can be interpreted by sphinx as a warning or error
151 151
     when translating the Changelog into an HTML file for
152 152
     documentation building within projects.
153 153
 
154
-    Currently removes:
155
-    * Escapes any '_' that sphinx can interpret as a link
156
-    * Escapes any '*' with sphinx will interpret as a new commit
157
-
154
+    * Escapes '_' which is interpreted as a link
155
+    * Escapes '*' which is interpreted as a new line
156
+    * Escapes '`' which is interpreted as a literal
158 157
     """
159 158
 
160 159
     msg = msg.replace('*', '\*')

Loading…
Cancel
Save