Skip to content

Commit e3d6ab5

Browse files
authored
use raw python strings to eliminate python warnings (#366)
1 parent ffc213a commit e3d6ab5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

scripts/generate_controls_doc.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
# File Header:
1212
def GetHeader():
13-
return """# How to Use the Intercept Layer for OpenCL Applications
13+
return r"""# How to Use the Intercept Layer for OpenCL Applications
1414
1515
This file is automatically generated using the script `generate_controls_doc.py`.
1616
Please do not edit it manually!
@@ -145,7 +145,7 @@ def GetHeader():
145145

146146
# File Footer:
147147
def GetFooter():
148-
return """
148+
return r"""
149149
---
150150
151151
\* Other names and brands may be claimed as the property of others.
@@ -184,7 +184,7 @@ def GetFooter():
184184
numberOfControls = 0
185185

186186
for line in srcFile:
187-
separator = re.search("^CLI_CONTROL_SEPARATOR\((.*)\)$", line)
187+
separator = re.search(r"^CLI_CONTROL_SEPARATOR\((.*)\)$", line)
188188
if separator:
189189
full = separator.group(1).strip()
190190

@@ -198,7 +198,7 @@ def GetFooter():
198198
numberOfSeparators = numberOfSeparators + 1
199199
continue
200200

201-
control = re.search("^CLI_CONTROL\((.*)\)$", line)
201+
control = re.search(r"^CLI_CONTROL\((.*)\)$", line)
202202
if control:
203203
full = control.group(1).strip()
204204

@@ -218,8 +218,8 @@ def GetFooter():
218218
# Replace underscores with escaped underscores:
219219
description = description.replace("_", "\\_")
220220
# Escape angle brackets:
221-
description = description.replace("<", "\<")
222-
description = description.replace(">", "\>")
221+
description = description.replace("<", r"\<")
222+
description = description.replace(">", r"\>")
223223

224224
docFile.write('##### `' + name + '` (' + type + ')\n\n')
225225
docFile.write(description + '\n\n')

0 commit comments

Comments
 (0)