JSDoc: update head(), last(), and nth() to reflect actual behav…

…ior (#3459)
ramda · May 2, 2024 · dcaac73 · dcaac73
1 parent ad50734
commit dcaac73
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/source/head.js b/source/head.js
@@ -11,7 +11,7 @@ import _nth from './internal/_nth.js';
  * @since v0.1.0
  * @category List
  * @sig [a] -> a | Undefined
- * @sig String -> String
+ * @sig String -> String | Undefined
  * @param {Array|String} list
  * @return {*}
  * @see R.tail, R.init, R.last
@@ -21,7 +21,7 @@ import _nth from './internal/_nth.js';
  *      R.head([]); //=> undefined
  *
  *      R.head('abc'); //=> 'a'
- *      R.head(''); //=> ''
+ *      R.head(''); //=> undefined
  */
 var head = _curry1(function(list) {
   return _nth(0, list);

diff --git a/source/last.js b/source/last.js
@@ -10,7 +10,7 @@ import _nth from './internal/_nth.js';
  * @since v0.1.4
  * @category List
  * @sig [a] -> a | Undefined
- * @sig String -> String
+ * @sig String -> String | Undefined
  * @param {*} list
  * @return {*}
  * @see R.init, R.head, R.tail
@@ -20,7 +20,7 @@ import _nth from './internal/_nth.js';
  *      R.last([]); //=> undefined
  *
  *      R.last('abc'); //=> 'c'
- *      R.last(''); //=> ''
+ *      R.last(''); //=> undefined
  */
 var last = _curry1(function(list) {
   return _nth(-1, list);

diff --git a/source/nth.js b/source/nth.js
@@ -10,7 +10,7 @@ import _nth from './internal/_nth.js';
  * @since v0.1.0
  * @category List
  * @sig Number -> [a] -> a | Undefined
- * @sig Number -> String -> String
+ * @sig Number -> String -> String | Undefined
  * @param {Number} offset
  * @param {*} list
  * @return {*}
@@ -22,7 +22,7 @@ import _nth from './internal/_nth.js';
  *      R.nth(-99, list); //=> undefined
  *
  *      R.nth(2, 'abc'); //=> 'c'
- *      R.nth(3, 'abc'); //=> ''
+ *      R.nth(3, 'abc'); //=> undefined
  * @symb R.nth(-1, [a, b, c]) = c
  * @symb R.nth(0, [a, b, c]) = a
  * @symb R.nth(1, [a, b, c]) = b