From 2ae5dae474f821e20b9b036d0a158556d65756ae Mon Sep 17 00:00:00 2001 From: yoff Date: Wed, 14 Jun 2023 20:55:45 +0200 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Rasmus Wriedt Larsen --- .../dataflow/new/internal/SummaryTypeTracker.qll | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/python/ql/lib/semmle/python/dataflow/new/internal/SummaryTypeTracker.qll b/python/ql/lib/semmle/python/dataflow/new/internal/SummaryTypeTracker.qll index d1a65e1c3e5..9ecc1b5ea1d 100644 --- a/python/ql/lib/semmle/python/dataflow/new/internal/SummaryTypeTracker.qll +++ b/python/ql/lib/semmle/python/dataflow/new/internal/SummaryTypeTracker.qll @@ -16,7 +16,8 @@ signature module Input { // Relating content and filters /** - * Gets a content filter to use for a `WithoutContent[content]` step, or has no result if + * Gets a content filter to use for a `WithoutContent[content]` step, (data is not allowed to be stored in `content`) + * or has no result if * the step should be treated as ordinary flow. * * `WithoutContent` is often used to perform strong updates on individual collection elements, but for @@ -26,7 +27,8 @@ signature module Input { TypeTrackerContentFilter getFilterFromWithoutContentStep(TypeTrackerContent content); /** - * Gets a content filter to use for a `WithContent[content]` step, or has no result if + * Gets a content filter to use for a `WithContent[content]` step, (data must be stored in `content`) + * or has no result if * the step cannot be handled by type-tracking. * * `WithContent` is often used to perform strong updates on individual collection elements (or rather @@ -57,10 +59,10 @@ signature module Input { /** Gets a summary component for content `c`. */ SummaryComponent content(TypeTrackerContent contents); - /** Gets a summary component where data is not allowed to be stored in `c`. */ + /** Gets a summary component where data is not allowed to be stored in `contents`. */ SummaryComponent withoutContent(TypeTrackerContent contents); - /** Gets a summary component where data must be stored in `c`. */ + /** Gets a summary component where data must be stored in `contents`. */ SummaryComponent withContent(TypeTrackerContent contents); // Callables