Skip to content

Commit 0e713e6

Browse files
committed
ruby/python: more consistent naming of parameters
1 parent af72509 commit 0e713e6

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

python/ql/lib/semmle/python/dataflow/new/internal/SummaryTypeTracker.qll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ signature module Input {
5050
/**
5151
* Gets the stack obtained by pushing `head` onto `tail`.
5252
*/
53-
SummaryComponentStack push(SummaryComponent component, SummaryComponentStack stack);
53+
SummaryComponentStack push(SummaryComponent head, SummaryComponentStack tail);
5454

5555
/** Gets a singleton stack representing a return. */
5656
SummaryComponent return();

ruby/ql/lib/codeql/ruby/typetracking/internal/SummaryTypeTracker.qll

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,8 @@ signature module Input {
1616

1717
// Relating content and filters
1818
/**
19-
* Gets a content filter to use for a `WithoutContent[content]` step, or has no result if
19+
* Gets a content filter to use for a `WithoutContent[content]` step, (data is not allowed to be stored in `content`)
20+
* or has no result if
2021
* the step should be treated as ordinary flow.
2122
*
2223
* `WithoutContent` is often used to perform strong updates on individual collection elements, but for
@@ -26,7 +27,8 @@ signature module Input {
2627
TypeTrackerContentFilter getFilterFromWithoutContentStep(TypeTrackerContent content);
2728

2829
/**
29-
* Gets a content filter to use for a `WithContent[content]` step, or has no result if
30+
* Gets a content filter to use for a `WithContent[content]` step, (data must be stored in `content`)
31+
* or has no result if
3032
* the step cannot be handled by type-tracking.
3133
*
3234
* `WithContent` is often used to perform strong updates on individual collection elements (or rather
@@ -48,7 +50,7 @@ signature module Input {
4850
/**
4951
* Gets the stack obtained by pushing `head` onto `tail`.
5052
*/
51-
SummaryComponentStack push(SummaryComponent component, SummaryComponentStack stack);
53+
SummaryComponentStack push(SummaryComponent head, SummaryComponentStack tail);
5254

5355
/** Gets a singleton stack representing a return. */
5456
SummaryComponent return();
@@ -57,10 +59,10 @@ signature module Input {
5759
/** Gets a summary component for content `c`. */
5860
SummaryComponent content(TypeTrackerContent contents);
5961

60-
/** Gets a summary component where data is not allowed to be stored in `c`. */
62+
/** Gets a summary component where data is not allowed to be stored in `contents`. */
6163
SummaryComponent withoutContent(TypeTrackerContent contents);
6264

63-
/** Gets a summary component where data must be stored in `c`. */
65+
/** Gets a summary component where data must be stored in `contents`. */
6466
SummaryComponent withContent(TypeTrackerContent contents);
6567

6668
// Callables

0 commit comments

Comments
 (0)