hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-16 16:53:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update unsupported format character documentaion, fix outdated reference link

Browse Source
This commit is contained in:
Joe Farebrother
2025-07-15 10:42:25 +01:00
parent df5f76872f
commit 7a7db0efe8
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
python/ql/src/Expressions/UnsupportedFormatCharacter.qhelp
View File

@@ -3,18 +3,19 @@
"qhelp.dtd">
<qhelp>
<overview>
<p>A format string, that is the string on the left hand side of an expression like <code>fmt % arguments</code>, must consist of legal conversion specifiers.
<p>A printf-style format string (i.e. a string that is used as the left hand side of the <code>%</code> operator, such as <code>fmt % arguments</code>)
must consist of valid conversion specifiers, such as <code>%s</code>, <code>%d</code>, etc.
Otherwise, a <code>ValueError</code> will be raised.
</p>
</overview>
<recommendation>
<p>Choose a legal conversion specifier.</p>
<p>Ensure a valid conversion specifier is used.</p>
</recommendation>
<example>
<p>In <code>format_as_tuple_incorrect</code>, "t" is not a legal conversion specifier.
<p>In the following example, <code>format_as_tuple_incorrect</code>, <code>%t</code> is not a valid conversion specifier.
</p>
<sample src="UnsupportedFormatCharacter.py" />
@@ -22,7 +23,7 @@ Otherwise, a <code>ValueError</code> will be raised.
</example>
<references>
<li>Python Library Reference: <a href="http://docs.python.org/library/stdtypes.html#string-formatting">String Formatting.</a> </li>
<li>Python Library Reference: <a href="https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatting">printf-style String Formatting.</a> </li>
</references>
</qhelp>