Fix obsolete check docs

sportradar · Aug 21, 2024 · 1a7695c · 1a7695c
1 parent 5544640
commit 1a7695c
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 10 deletions.
diff --git a/workspace/lib/mix/tasks/workspace.check.ex b/workspace/lib/mix/tasks/workspace.check.ex
@@ -9,7 +9,7 @@ defmodule Mix.Tasks.Workspace.Check do
                     :excluded_tags
                   ])
 
-  @shortdoc "Runs configured checkers on the current workspace"
+  @shortdoc "Runs configured checks on the current workspace"
 
   @moduledoc """
   Check the workspace using the configured checks.

diff --git a/workspace/lib/workspace/check.ex b/workspace/lib/workspace/check.ex
@@ -37,7 +37,7 @@ defmodule Workspace.Check do
                 )
 
   @moduledoc """
-  A behaviour for implementing workspace checker.
+  A behaviour for implementing workspace check.
 
   ## Introduction
 

diff --git a/workspace/lib/workspace/check/result.ex b/workspace/lib/workspace/check/result.ex
@@ -33,7 +33,7 @@ defmodule Workspace.Check.Result do
             check: nil,
             project: nil,
             status: nil,
-            # should be set by checkers
+            # should be set by checks
             meta: []
 
   @doc """

diff --git a/workspace/lib/workspace/checks/validate_config_path.ex b/workspace/lib/workspace/checks/validate_config_path.ex
@@ -35,14 +35,17 @@ defmodule Workspace.Checks.ValidateConfigPath do
 
   ## Example
 
-  In order to configure this checker add the following, under `checkers`,
-  in your `workspace.exs`:
+  In order to configure this check add the following, under `checks`,
+  in your `.workspace.exs`:
 
   ```elixir
   [
-    checker: Workspace.Checkers.ConfigPath,
-    config_attribute: :deps_path,
-    expected_path: "artifacts/deps"
+    module: Workspace.Checks.ValidateConfigPath,
+    description: "all projects must have a common dependencies path",
+    opts: [
+      config_attribute: :deps_path,
+      expected_path: "artifacts/deps"
+    ]
   ]
   ```
   """

diff --git a/workspace/lib/workspace/checks/validate_project.ex b/workspace/lib/workspace/checks/validate_project.ex
@@ -37,8 +37,8 @@ defmodule Workspace.Checks.ValidateProject do
 
   ## Example
 
-  In order to configure this checker add the following, under `checks`,
-  in your `workspace.exs`:
+  In order to configure this check add the following, under `checks`,
+  in your `.workspace.exs`:
 
   ```elixir
   [