Skip to content

Commit 8b174ea

Browse files
joefarebrotheryoff
andauthored
Apply suggestions from code review - update doc comments
Co-authored-by: yoff <[email protected]>
1 parent dcbcf7e commit 8b174ea

File tree

1 file changed

+6
-6
lines changed
  • python/ql/lib/semmle/python/frameworks

1 file changed

+6
-6
lines changed

python/ql/lib/semmle/python/frameworks/Lxml.qll

+6-6
Original file line numberDiff line numberDiff line change
@@ -320,13 +320,13 @@ module Lxml {
320320
override DataFlow::Node getAPathArgument() { result = this.getAnInput() }
321321
}
322322

323-
/** Provides models for instances of the `lxml.etree.Element` class. */
323+
/** Provides models for the `lxml.etree.Element` class. */
324324
module Element {
325325
/** Gets a reference to the `Element` class. */
326326
API::Node classRef() { result = etreeRef().getMember(["Element", "_Element"]) }
327327

328328
/**
329-
* A source of instances of `lxml.etree.Element` instances, extend this class to model new instances.
329+
* A source of `lxml.etree.Element` instances, extend this class to model new instances.
330330
*
331331
* This can include instantiations of the class, return values from function
332332
* calls, or a special parameter that will be set when functions are called by an external
@@ -408,7 +408,7 @@ module Lxml {
408408
|
409409
call.calls(nodeFrom,
410410
// We consider a node to be tainted if there could be taint anywhere in the element tree;
411-
// So sibling nodes (e.g. `getnext`) are also tainted.
411+
// so sibling nodes (e.g. `getnext`) are also tainted.
412412
// This ensures nodes like `elem[0].getnext()` are tracked.
413413
[
414414
"cssselect", "find", "findall", "findtext", "get", "getchildren", "getiterator",
@@ -425,13 +425,13 @@ module Lxml {
425425
}
426426
}
427427

428-
/** Provides models for instances of the `lxml.etree.ElementTree` class. */
428+
/** Provides models for the `lxml.etree.ElementTree` class. */
429429
module ElementTree {
430430
/** Gets a reference to the `ElementTree` class. */
431431
API::Node classRef() { result = etreeRef().getMember(["ElementTree", "_ElementTree"]) }
432432

433433
/**
434-
* A source of instances of `lxml.etree.ElementTree` instances, extend this class to model new instances.
434+
* A source of `lxml.etree.ElementTree` instances; extend this class to model new instances.
435435
*
436436
* This can include instantiations of the class, return values from function
437437
* calls, or a special parameter that will be set when functions are called by an external
@@ -452,7 +452,7 @@ module Lxml {
452452
ElementTreeInstance() { this = classRef().getAnInstance() }
453453
}
454454

455-
/** The result of a parst operation that returns an `ElementTree`. */
455+
/** The result of a parse operation that returns an `ElementTree`. */
456456
private class ParseResult extends InstanceSource {
457457
ParseResult() { this = etreeRef().getMember("parse").getReturn() }
458458
}

0 commit comments

Comments
 (0)