docs: Fix misspells in Ranker and List docs (#5634)

* docs: Fix misspells in Ranker and List docs * ci: Build frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/8446519502 * ci: Build frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/8450263804 * Add one more `@example` tag * ci: Build frontend Workflow run: https://github.com/HumanSignal/label-studio/actions/runs/8450357277 --------- Co-authored-by: robot-ci-heartex <[email protected]> Co-authored-by: hlomzik <[email protected]> Co-authored-by: hlomzik <[email protected]>
HumanSignal · Mar 27, 2024 · a2cd3ba · a2cd3ba
1 parent c6a1a2c
commit a2cd3ba
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 20 deletions.
diff --git a/docs/source/tags/list.md b/docs/source/tags/list.md
@@ -41,7 +41,7 @@ Example data for List tag
   "items": [
     { "id": "blog", "title": "10 tips to write a better function", "body": "There is nothing worse than being left in the lurch when it comes to writing a function!" },
     { "id": "mdn", "title": "Arrow function expressions", "body": "An arrow function expression is a compact alternative to a traditional function" },
-    { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." },
+    { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." }
   ]
 }
 ```
diff --git a/docs/source/tags/ranker.md b/docs/source/tags/ranker.md
@@ -36,16 +36,22 @@ Visual appearance can be changed via Style tag with these predefined classnames
 ```
 ### Example
 
-Example data and result for Ranker tag
+Example task data for Ranker tag
 
 ```json
 {
   "items": [
     { "id": "blog", "title": "10 tips to write a better function", "body": "There is nothing worse than being left in the lurch when it comes to writing a function!" },
     { "id": "mdn", "title": "Arrow function expressions", "body": "An arrow function expression is a compact alternative to a traditional function" },
-    { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." },
+    { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." }
   ]
 }
+```
+### Example
+
+Example result for Ranker tag
+
+```json
 {
   "from_name": "rank",
   "to_name": "results",

diff --git a/web/dist/apps/labelstudio/version.json b/web/dist/apps/labelstudio/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "Merge branch 'develop' into 'docs/193'",
-  "commit": "9742997963cf3e6946dade6d78892352ef1549ff",
-  "date": "2024-03-25T17:41:47.000Z",
-  "branch": "docs/193"
+  "message": "Add one more `@example` tag",
+  "commit": "f4b43e51fcdedc4f9f79d7b1a567d63454b44c6e",
+  "date": "2024-03-27T10:34:10.000Z",
+  "branch": "fix-misspells-frontend-docs"
 }
diff --git a/web/dist/libs/datamanager/version.json b/web/dist/libs/datamanager/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "Merge branch 'develop' into 'docs/193'",
-  "commit": "9742997963cf3e6946dade6d78892352ef1549ff",
-  "date": "2024-03-25T17:41:47.000Z",
-  "branch": "docs/193"
+  "message": "Add one more `@example` tag",
+  "commit": "f4b43e51fcdedc4f9f79d7b1a567d63454b44c6e",
+  "date": "2024-03-27T10:34:10.000Z",
+  "branch": "fix-misspells-frontend-docs"
 }
diff --git a/web/dist/libs/editor/main.js b/web/dist/libs/editor/main.js
diff --git a/web/dist/libs/editor/main.js.map b/web/dist/libs/editor/main.js.map
diff --git a/web/dist/libs/editor/version.json b/web/dist/libs/editor/version.json
@@ -1,6 +1,6 @@
 {
-  "message": "Merge branch 'develop' into 'docs/193'",
-  "commit": "9742997963cf3e6946dade6d78892352ef1549ff",
-  "date": "2024-03-25T17:41:47.000Z",
-  "branch": "docs/193"
+  "message": "Add one more `@example` tag",
+  "commit": "f4b43e51fcdedc4f9f79d7b1a567d63454b44c6e",
+  "date": "2024-03-27T10:34:10.000Z",
+  "branch": "fix-misspells-frontend-docs"
 }
diff --git a/web/libs/editor/src/tags/control/Ranker.js b/web/libs/editor/src/tags/control/Ranker.js
@@ -32,14 +32,16 @@ const ORIGINAL_ITEMS_KEY = '_';
  *   <Ranker name="rank" toName="results" />
  * </View>
  * @example
- * <!-- Example data and result for Ranker tag -->
+ * <!-- Example task data for Ranker tag -->
  * {
  *   "items": [
  *     { "id": "blog", "title": "10 tips to write a better function", "body": "There is nothing worse than being left in the lurch when it comes to writing a function!" },
  *     { "id": "mdn", "title": "Arrow function expressions", "body": "An arrow function expression is a compact alternative to a traditional function" },
- *     { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." },
+ *     { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." }
  *   ]
  * }
+ * @example
+ * <!-- Example result for Ranker tag -->
  * {
  *   "from_name": "rank",
  *   "to_name": "results",

diff --git a/web/libs/editor/src/tags/object/List.js b/web/libs/editor/src/tags/object/List.js
@@ -29,7 +29,7 @@ import Base from './Base';
  *   "items": [
  *     { "id": "blog", "title": "10 tips to write a better function", "body": "There is nothing worse than being left in the lurch when it comes to writing a function!" },
  *     { "id": "mdn", "title": "Arrow function expressions", "body": "An arrow function expression is a compact alternative to a traditional function" },
- *     { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." },
+ *     { "id": "wiki", "title": "Arrow (computer science)", "body": "In computer science, arrows or bolts are a type class..." }
  *   ]
  * }
  * @name List