mirror of
https://github.com/github/codeql.git
synced 2026-04-26 17:25:19 +02:00
Minor doc updates; updating python 2 references to python 3 and updating grammar
This commit is contained in:
@@ -6,7 +6,7 @@
|
||||
|
||||
<overview>
|
||||
<p>When a function contains both explicit returns (<code>return value</code>) and implicit returns
|
||||
(where code falls off the end of a function) this often indicates that a return
|
||||
(where code falls off the end of a function), this often indicates that a return
|
||||
statement has been forgotten. It is best to return an explicit return value even when returning
|
||||
<code>None</code> because this makes it easier for other developers to read your code.
|
||||
</p>
|
||||
@@ -29,7 +29,7 @@ return value of <code>None</code> as this equates to <code>False</code>. However
|
||||
</example>
|
||||
<references>
|
||||
|
||||
<li>Python Language Reference: <a href="http://docs.python.org/2/reference/compound_stmts.html#function">Function definitions</a>.
|
||||
<li>Python Language Reference: <a href="http://docs.python.org/3/reference/compound_stmts.html#function">Function definitions</a>.
|
||||
</li>
|
||||
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
/**
|
||||
* @name Explicit returns mixed with implicit (fall through) returns
|
||||
* @description Mixing implicit and explicit returns indicates a likely error as implicit returns always return 'None'.
|
||||
* @description Mixing implicit and explicit returns indicates a likely error as implicit returns always return `None`.
|
||||
* @kind problem
|
||||
* @tags quality
|
||||
* reliability
|
||||
@@ -31,4 +31,4 @@ predicate has_implicit_return(Function func) {
|
||||
from Function func
|
||||
where explicitly_returns_non_none(func) and has_implicit_return(func)
|
||||
select func,
|
||||
"Mixing implicit and explicit returns may indicate an error as implicit returns always return None."
|
||||
"Mixing implicit and explicit returns may indicate an error, as implicit returns always return None."
|
||||
|
||||
@@ -22,7 +22,7 @@ not logical in the context of an initializer.</p>
|
||||
</example>
|
||||
<references>
|
||||
|
||||
<li>Python: <a href="http://docs.python.org/2.7/reference/datamodel.html#object.__init__">The __init__ method</a>.</li>
|
||||
<li>Python: <a href="http://docs.python.org/3/reference/datamodel.html#object.__init__">The __init__ method</a>.</li>
|
||||
|
||||
</references>
|
||||
</qhelp>
|
||||
|
||||
@@ -37,7 +37,7 @@ function with a default of <code>default=None</code>, check if the parameter is
|
||||
<references>
|
||||
|
||||
<li>Effbot: <a href="https://web.archive.org/web/20201112004749/http://effbot.org/zone/default-values.htm">Default Parameter Values in Python</a>.</li>
|
||||
<li>Python Language Reference: <a href="http://docs.python.org/2/reference/compound_stmts.html#function-definitions">Function definitions</a>.</li>
|
||||
<li>Python Language Reference: <a href="http://docs.python.org/3/reference/compound_stmts.html#function-definitions">Function definitions</a>.</li>
|
||||
|
||||
|
||||
</references>
|
||||
|
||||
Reference in New Issue
Block a user