Merge pull request #63 from sandstreamdev/add_missing_examples_for_existing_modules

Add missing examples and questions

Author: przemyslawzalewski

README.md

@@ -5,17 +5,17 @@
   "examples": [
     {
       "language": "javascript",
-      "content": "any([]); // ⇒ false"
+      "content": "any([]);\n// ⇒ false"
     },
     {
       "language": "javascript",
-      "content": "any([1, 2, 3]); // ⇒ true"
+      "content": "any([1, 2, 3]);\n// ⇒ true"
     }
   ],
   "questions": [
-    "How to check if an array is empty (in JavaScript)?",
-    "How to check if array is empty or null or undefined (in JavaScript)?",
-    "Check if an array is empty or not (in JavaScript).",
-    "Check if an array is empty or exists (in JavaScript)."
+    "How to check if an array is empty?",
+    "How to check if an array is empty or null or undefined?",
+    "How to check if an array is empty or not?",
+    "How to check if an array is empty or doesn't exist?"
   ]
 }

array/README.md

@@ -14,17 +14,19 @@ Checks if the given array is present and it is not empty (contains at least one
 
 <!-- prettier-ignore-start -->
 ```javascript
-any([]); // ⇒ false
+any([]);
+// ⇒ false
 ```
 
 ```javascript
-any([1, 2, 3]); // ⇒ true
+any([1, 2, 3]);
+// ⇒ true
 ```
 <!-- prettier-ignore-end -->
 
 ## Questions
 
-- How to check if an array is empty (in JavaScript)?
-- How to check if array is empty or null or undefined (in JavaScript)?
-- Check if an array is empty or not (in JavaScript).
-- Check if an array is empty or exists (in JavaScript).
+- How to check if an array is empty?
+- How to check if an array is empty or null or undefined?
+- How to check if an array is empty or not?
+- How to check if an array is empty or doesn't exist?

array/any.json

@@ -1,12 +1,20 @@
 {
   "name": "are",
-  "description": "Checks if given arguments are all `Arrays`.",
+  "description": "Checks if the given arguments are all `Arrays`.",
   "signature": "(...xs: any[]) => boolean",
   "examples": [
     {
       "language": "javascript",
-      "content": "are(); // ⇒ TODO"
+      "content": "are([2, 3]);\n// ⇒ true"
+    },
+    {
+      "language": "javascript",
+      "content": "are([1, 2, 3], []);\n// ⇒ true"
+    },
+    {
+      "language": "javascript",
+      "content": "are([1, 2, 3], 8, [1, 3], \"test\");\n// ⇒ false"
     }
   ],
-  "questions": ["TODO: List questions that may this function answers."]
+  "questions": ["How to check if all the given values are arrays?"]
 }

array/any.md

@@ -1,6 +1,6 @@
 # are
 
-Checks if given arguments are all `Arrays`.
+Checks if the given arguments are all `Arrays`.
 
 ## Type signature
 
@@ -9,3 +9,26 @@ Checks if given arguments are all `Arrays`.
 (...xs: any[]) => boolean
 ```
 <!-- prettier-ignore-end -->
+
+## Examples
+
+<!-- prettier-ignore-start -->
+```javascript
+are([2, 3]);
+// ⇒ true
+```
+
+```javascript
+are([1, 2, 3], []);
+// ⇒ true
+```
+
+```javascript
+are([1, 2, 3], 8, [1, 3], "test");
+// ⇒ false
+```
+<!-- prettier-ignore-end -->
+
+## Questions
+
+- How to check if all the given values are arrays?

array/are.json

@@ -1,6 +1,6 @@
 {
   "name": "chunk",
-  "description": "Splits the given array into array of chunks of up to the given length.",
+  "description": "Splits the given array into an array of chunks of up to the given length.",
   "signature": "(count: number) => (xs: any[]) => any[]",
   "examples": [
     {
@@ -12,5 +12,8 @@
       "content": "chunk(3)(['a', 'b', 'c', 'd']);\n// ⇒ [['a', 'b', 'c'], ['d']]"
     }
   ],
-  "questions": ["TODO: List questions that may this function answer."]
+  "questions": [
+    "How to split an array into chunks?",
+    "How to split an array into chunks of the same size?"
+  ]
 }

array/are.md

@@ -1,6 +1,6 @@
 # chunk
 
-Splits the given array into array of chunks of up to the given length.
+Splits the given array into an array of chunks of up to the given length.
 
 ## Type signature
 
@@ -23,3 +23,8 @@ chunk(3)(['a', 'b', 'c', 'd']);
 // ⇒ [['a', 'b', 'c'], ['d']]
 ```
 <!-- prettier-ignore-end -->
+
+## Questions
+
+- How to split an array into chunks?
+- How to split an array into chunks of the same size?

array/chunk.json

@@ -1,12 +1,14 @@
 {
   "name": "difference",
-  "description": "TODO: Fill short description here.",
+  "description": "Computes a set difference between the two given arrays.",
   "signature": "(xs: any[], ys: any[]) => any[]",
   "examples": [
     {
       "language": "javascript",
-      "content": "difference(); // ⇒ TODO"
+      "content": "difference([1, 2, 3, 4, 5, 6], [2, 4]);\n// ⇒ [1, 3, 5, 6]"
     }
   ],
-  "questions": ["TODO: List questions that may this function answers."]
+  "questions": [
+    "How to find elements which are present in the first array and not in the second?"
+  ]
 }

array/chunk.md

@@ -1,9 +1,24 @@
 # difference
 
+Computes a set difference between the two given arrays.
+
 ## Type signature
 
 <!-- prettier-ignore-start -->
 ```typescript
 (xs: any[], ys: any[]) => any[]
 ```
 <!-- prettier-ignore-end -->
+
+## Examples
+
+<!-- prettier-ignore-start -->
+```javascript
+difference([1, 2, 3, 4, 5, 6], [2, 4]);
+// ⇒ [1, 3, 5, 6]
+```
+<!-- prettier-ignore-end -->
+
+## Questions
+
+- How to find elements which are present in the first array and not in the second?