summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGage Hugo <gagehugo@gmail.com>2017-04-18 10:24:02 -0500
committerGage Hugo <gagehugo@gmail.com>2017-04-18 10:24:02 -0500
commit2cf1d2eb18e14058ef64553ee6f86995410ac545 (patch)
tree6a9f84ac8b8b99b1241b09d1e4f8b865a45c492c
parentca6e92c723c927d730db251c428b402d1c0701cb (diff)
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
Notes
Notes (review): Code-Review+2: Monty Taylor <mordred@inaugust.com> Code-Review+2: Julien Danjou <julien@danjou.info> Workflow+1: Julien Danjou <julien@danjou.info> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Tue, 18 Apr 2017 17:41:40 +0000 Reviewed-on: https://review.openstack.org/457692 Project: openstack-dev/pbr Branch: refs/heads/master
-rw-r--r--pbr/git.py9
1 files changed, 4 insertions, 5 deletions
diff --git a/pbr/git.py b/pbr/git.py
index 1c70194..f2855dd 100644
--- a/pbr/git.py
+++ b/pbr/git.py
@@ -146,15 +146,14 @@ def get_git_short_sha(git_dir=None):
146def _clean_changelog_message(msg): 146def _clean_changelog_message(msg):
147 """Cleans any instances of invalid sphinx wording. 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 that can be interpreted by sphinx as a warning or error 150 that can be interpreted by sphinx as a warning or error
151 when translating the Changelog into an HTML file for 151 when translating the Changelog into an HTML file for
152 documentation building within projects. 152 documentation building within projects.
153 153
154 Currently removes: 154 * Escapes '_' which is interpreted as a link
155 * Escapes any '_' that sphinx can interpret as a link 155 * Escapes '*' which is interpreted as a new line
156 * Escapes any '*' with sphinx will interpret as a new commit 156 * Escapes '`' which is interpreted as a literal
157
158 """ 157 """
159 158
160 msg = msg.replace('*', '\*') 159 msg = msg.replace('*', '\*')