rigortype 0.3.7 → 0.3.9

data/lib/rigor/analysis/runner/effect_annotation_residual_pass.rb

@@ -58,8 +58,7 @@ module Rigor
                   "every run of the project."
         private_constant :MESSAGE
 
-        # @param configuration [Rigor::Configuration]
-        # @param virtual_rbs [Array<Array(String, String)>, nil] `[buffer name, RBS source]` pairs the
+        # @param virtual_rbs — `[buffer name, RBS source]` pairs the
         #   run ALREADY resolved; never a loader built for this pass. Empty / nil simply drops the
         #   virtual-RBS stratum.
         def initialize(configuration:, virtual_rbs: nil)
@@ -67,7 +66,7 @@ module Rigor
           @virtual_rbs = virtual_rbs
         end
 
-        # @return [Array<Diagnostic>] zero or one.
+        # @return zero or one.
         def diagnostics
           return NO_DIAGNOSTICS if @configuration.effects_enabled?
           return NO_DIAGNOSTICS if @configuration.disabled_rules.include?(RULE)

data/lib/rigor/analysis/runner/effect_envelope_pass.rb

@@ -78,22 +78,21 @@ module Rigor
         LABELS_CONSEQUENCE = "the label is not registered"
         private_constant :LABELS_CONSEQUENCE
 
-        # @param configuration [Rigor::Configuration]
-        # @param rbs_loader [Rigor::Environment::RbsLoader, nil] the run's loader; nil disables the pass.
-        # @param effect_table [Rigor::Effects::EffectTable] the propagated graph.
-        # @param discovery [#call] forces and returns the cross-file discovery tables as
+        # @param rbs_loader — the run's loader; nil disables the pass.
+        # @param effect_table — the propagated graph.
+        # @param discovery — forces and returns the cross-file discovery tables as
         #   `[def_sources, singleton_def_sources, class_sources]`. Called only when a finding needs a
         #   position — a judged-clean envelope never forces it.
-        # @param sources [Hash{String => String}] in-memory sources, for the buffer-backed run path.
-        # @param unit_sources [Hash{String => Array<String>}] `Runner#effect_sources` — where each effect
+        # @param sources — in-memory sources, for the buffer-backed run path.
+        # @param unit_sources — `Runner#effect_sources` — where each effect
         #   unit is defined, which is what an `effects.envelopes[].match:` path glob selects on. Its paths
         #   are relativised against the working directory, which is the project root for every run that
         #   reaches here (the same assumption `Snapshot.build` makes about `reach:`).
-        # @param ancestry [#call, nil] returns the run's as-written superclass table
+        # @param ancestry — returns the run's as-written superclass table
         #   (`FileCollection#superclasses`) — the nominal relation `effect.liskov-widened` reads. A
         #   lambda, and called only once an envelope exists, because merging the run's collections is
-        #   not free.
-        # @param apply_tolerated [Boolean] false runs the judgment with an empty tolerated set
+        #   not free. nil leaves that relation empty.
+        # @param apply_tolerated — false runs the judgment with an empty tolerated set
         #   (`--no-tolerated-effects`).
         def initialize(configuration:, rbs_loader:, effect_table:, discovery:, # rubocop:disable Metrics/ParameterLists
                        sources: nil, unit_sources: nil, ancestry: nil, apply_tolerated: true,
@@ -109,7 +108,7 @@ module Rigor
           @apply_tolerated = apply_tolerated
         end
 
-        # @return [Array<Diagnostic>] one per (method, exceeding label) plus one per unrecognised
+        # @return one per (method, exceeding label) plus one per unrecognised
         #   label, suppression already applied.
         def diagnostics
           return NO_DIAGNOSTICS unless @configuration.effects_check?