wip

Author: stephencelis

Sources/IssueReporting/IssueReporters/BreakpointReporter.swift

@@ -35,8 +35,6 @@
       raise(SIGTRAP)
     }
 
-    // TODO: Should this reporter do anything with *expected* issues?
-
     var isDebuggerAttached: Bool {
       var name: [Int32] = [CTL_KERN, KERN_PROC, KERN_PROC_PID, getpid()]
       var info: kinfo_proc = kinfo_proc()

Sources/IssueReporting/IssueReporters/FatalErrorReporter.swift

@@ -22,6 +22,4 @@ public struct FatalErrorReporter: IssueReporter {
     }
     Swift.fatalError(message, file: filePath, line: line)
   }
-
-  // TODO: Should this reporter do anything with *expected* issues?
 }

Sources/IssueReporting/IssueReporters/RuntimeWarningReporter.swift

@@ -58,7 +58,7 @@ public struct RuntimeWarningReporter: IssueReporter {
 
   @_transparent
   public func reportIssue(
-    _ message: @autoclosure () -> String?, // TODO: Handle `nil`/`""` better
+    _ message: @autoclosure () -> String?,
     fileID: StaticString,
     filePath: StaticString,
     line: UInt,

Sources/IssueReporting/TestContext.swift

@@ -7,19 +7,18 @@ public enum TestContext {
   /// The XCTest framework.
   case xcTest
 
-  // TODO: Fix docs
   /// The context associated with current test.
   ///
   /// How the test context is detected depends on the framework:
   ///
-  ///   * If Swift Testing is running, _and_ this is called from the current task, this will return
-  ///     ``swiftTesting``. In this way, `TestContext.current == .swiftTesting` is equivalent to
-  ///     checking `Test.current != nil`, but safe to do from library and application code.
+  ///   * If Swift Testing is running, _and_ this is called from the current test's task, this will
+  ///     return ``swiftTesting``. In this way, `TestContext.current == .swiftTesting` is equivalent
+  ///     to checking `Test.current != nil`, but safe to do from library and application code.
   ///
   ///   * If XCTest is running, _and_ this is called during the execution of a test _regardless_ of
   ///     task, this will return ``xcTest``.
   ///
-  /// To detect if the current process is a test runner, use ``isTesting``, instead.
+  /// If executed outside of a test process, this will return `nil`.
   public static var current: Self? {
     guard isTesting else { return nil }
     if _currentTestIsNotNil() {