Add a beter explanation of how we call the packwerk cli

Author: martinemde

lib/danger-packwerk/packwerk_wrapper.rb

@@ -16,10 +16,15 @@ module DangerPackwerk
   class PackwerkWrapper
     extend T::Sig
 
+    # This code is partially copied from exe/packwerk within the packwerk gem. We're imitating the
+    # cli here but with our own offense formatter to collect the violating data directly.
+    #
+    # We capture and ignore the output of the Cli so that we don't leak it to the build system logs.
+    # When packwerk produces errors it can make the build system look like it's failing when really
+    # this is expected behavior.
     sig { params(files: T::Array[String]).returns(T::Array[Packwerk::ReferenceOffense]) }
     def self.get_offenses_for_files(files)
       formatter = OffensesAggregatorFormatter.new
-      # This is mostly copied from exe/packwerk within the packwerk gem, but we use our own formatters
       ENV['RAILS_ENV'] = 'test'
       cli = Packwerk::Cli.new(offenses_formatter: formatter, out: StringIO.new)
       cli.execute_command(['check', *files])