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
This commit is contained in:
parent
ca6e92c723
commit
2cf1d2eb18
@ -146,15 +146,14 @@ def get_git_short_sha(git_dir=None):
|
|||||||
def _clean_changelog_message(msg):
|
def _clean_changelog_message(msg):
|
||||||
"""Cleans any instances of invalid sphinx wording.
|
"""Cleans any instances of invalid sphinx wording.
|
||||||
|
|
||||||
This removes any instances of invalid characters or wording
|
This escapes/removes any instances of invalid characters
|
||||||
that can be interpreted by sphinx as a warning or error
|
that can be interpreted by sphinx as a warning or error
|
||||||
when translating the Changelog into an HTML file for
|
when translating the Changelog into an HTML file for
|
||||||
documentation building within projects.
|
documentation building within projects.
|
||||||
|
|
||||||
Currently removes:
|
* Escapes '_' which is interpreted as a link
|
||||||
* Escapes any '_' that sphinx can interpret as a link
|
* Escapes '*' which is interpreted as a new line
|
||||||
* Escapes any '*' with sphinx will interpret as a new commit
|
* Escapes '`' which is interpreted as a literal
|
||||||
|
|
||||||
"""
|
"""
|
||||||
|
|
||||||
msg = msg.replace('*', '\*')
|
msg = msg.replace('*', '\*')
|
||||||
|
Loading…
Reference in New Issue
Block a user