Update docs

WordPress · Jul 31, 2024 · 496bae7 · 496bae7
1 parent 2991737
commit 496bae7
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/creating-a-runtime-check.md b/docs/creating-a-runtime-check.md
@@ -25,6 +25,14 @@ class My_Custom_Check implements Runtime_Check {
   public function run( Check_Result $result ) {
     // Handle running the check and adding warnings or errors to the result.
   }
+
+  public function get_description(): string {
+    // Return a short description about this check.
+  }
+
+  public function get_documentation_url(): string {
+    // Return the URL for further information about this check.
+  }
 }
 ```
 
@@ -55,6 +63,14 @@ class My_Custom_Check extends Abstract_Runtime_Check {
   public function run( Check_Result $result ) {
     // Handle running the check and adding warnings or errors to the result.
   }
+
+  public function get_description(): string {
+    // Return a short description about this check.
+  }
+
+  public function get_documentation_url(): string {
+    // Return the URL for further information about this check.
+  }
 }
 ```