Updating documentation

fjcaetano · Nov 12, 2018 · 59c5223 · 59c5223
1 parent 484ed94
commit 59c5223
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -51,3 +51,6 @@ fastlane/Preview.html
 fastlane/screenshots
 fastlane/README.md
 fastlane/test_output
+
+## VS Code
+.vscode
diff --git a/ReCaptcha/Classes/ReCaptcha.swift b/ReCaptcha/Classes/ReCaptcha.swift
@@ -199,14 +199,22 @@ public class ReCaptcha {
         manager.reset()
     }
 
+    // MARK: - Development
+
 #if DEBUG
-    /// Forces the challenge to be explicitly displayed.
+    /// Forces the challenge widget to be explicitly displayed.
     public var forceVisibleChallenge: Bool {
         get { return manager.forceVisibleChallenge }
         set { manager.forceVisibleChallenge = newValue }
     }
 
-    /// Allows validation stubbing for testing
+    /**
+     Allows validation stubbing for testing
+
+     When this property is set to `true`, every call to `validate()` will immediately be resolved with `.token("")`.
+     
+     Use only when testing your application.
+    */
     public var shouldSkipForTests: Bool {
         get { return manager.shouldSkipForTests }
         set { manager.shouldSkipForTests = newValue }

diff --git a/fastlane/Fastfile b/fastlane/Fastfile
@@ -33,7 +33,6 @@ platform :ios do
       executable: "Example/Pods/Swiftlint/swiftlint",
       strict: true,
       reporter: "emoji",
-
     )
 
     # The problem lies in the fact (or rather: serious bug in xcodebuild) that