Polish

jashkenas · jgonggrijp · Jun 26, 2020 · Mar 30, 2020 · Mar 30, 2020 · Apr 14, 2020
commit 2b9741ffeb207648888f929a14331311a0945bec
diff --git a/modules/debounce.js b/modules/debounce.js
@@ -2,7 +2,7 @@ import restArguments from './restArguments.js';
 import delay from './delay.js';
 
 // Returns a function, that, as long as it continues to be invoked, will not
-// be triggered. The function will be called after it stops being called for
+// be triggered. The function will be triggered after it stops being called for
 // N milliseconds. If `immediate` is passed, trigger the function on the
 // leading edge, instead of the trailing.
 export default function debounce(func, wait, immediate) {

diff --git a/modules/extendOwn.js b/modules/extendOwn.js
@@ -1,6 +1,7 @@
 import createAssigner from './_createAssigner.js';
 import keys from './keys.js';
 
-// Assigns a given object with all the own properties in the passed-in object(s).
+// Assigns a given object with all the own properties in the passed-in
+// object(s).
 // (https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object/assign)
 export default createAssigner(keys);
diff --git a/modules/index-default.js b/modules/index-default.js
@@ -19,7 +19,7 @@ import { mixin } from './index.js';
 
 // Add all of the Underscore functions to the wrapper object.
 var _ = mixin(allExports);
-// Legacy Node.js API
+// Legacy Node.js API.
 _._ = _;
 // Export the Underscore API.
 export default _;
diff --git a/modules/index.js b/modules/index.js
@@ -7,7 +7,7 @@
 export { VERSION } from './_setup.js';
 export { default as restArguments } from './restArguments.js';
 
-// Object Functions (except for findKey and omit).
+// Object Functions (except for `findKey` and `omit`).
 export { default as isObject } from './isObject.js';
 export { default as isNull } from './isNull.js';
 export { default as isUndefined } from './isUndefined.js';
@@ -95,7 +95,7 @@ export { default as lastIndexOf } from './lastIndexOf.js';
 export { default as find, default as detect } from './find.js';
 export { default as findWhere } from './findWhere.js';
 
-// Collection Functions (plus omit).
+// Collection Functions (plus `omit`).
 export { default as each, default as forEach } from './each.js';
 export { default as map, default as collect } from './map.js';
 export { default as reduce, default as foldl, default as inject } from './reduce.js';

diff --git a/modules/isArguments.js b/modules/isArguments.js
@@ -2,6 +2,7 @@ import tagTester from './_tagTester.js';
 import has from './_has.js';
 
 var isArguments = tagTester('Arguments');
+
 // Define a fallback version of the method in browsers (ahem, IE < 9), where
 // there isn't any inspectable "Arguments" type.
 (function() {

diff --git a/modules/isArray.js b/modules/isArray.js
@@ -2,5 +2,5 @@ import { nativeIsArray } from './_setup.js';
 import tagTester from './_tagTester.js';
 
 // Is a given value an array?
-// Delegates to ECMA5's native Array.isArray
+// Delegates to ECMA5's native `Array.isArray`.
 export default nativeIsArray || tagTester('Array');
diff --git a/modules/isFunction.js b/modules/isFunction.js
@@ -2,8 +2,9 @@ import tagTester from './_tagTester.js';
 import { root } from './_setup.js';
 
 var isFunction = tagTester('Function');
-// Optimize `isFunction` if appropriate. Work around some typeof bugs in old v8,
-// IE 11 (#1621), Safari 8 (#1929), and PhantomJS (#2236).
+
+// Optimize `isFunction` if appropriate. Work around some `typeof` bugs in old
+// v8, IE 11 (#1621), Safari 8 (#1929), and PhantomJS (#2236).
 var nodelist = root.document && root.document.childNodes;
 if (typeof /./ != 'function' && typeof Int8Array != 'object' && typeof nodelist != 'function') {
   isFunction = function(obj) {

diff --git a/modules/isTypedArray.js b/modules/isTypedArray.js
@@ -8,7 +8,8 @@ var typedArrayPattern = /\[object ((I|Ui)nt(8|16|32)|Float(32|64)|Uint8Clamped|B
 function isTypedArray(obj) {
   // `ArrayBuffer.isView` is the most future-proof, so use it when available.
   // Otherwise, fall back on the above regular expression.
-  return nativeIsView ? (nativeIsView(obj) && !isDataView(obj)) : isBufferLike(obj) && typedArrayPattern.test(toString.call(obj));
+  return nativeIsView ? (nativeIsView(obj) && !isDataView(obj)) :
+                isBufferLike(obj) && typedArrayPattern.test(toString.call(obj));
 }
 
 export default supportsArrayBuffer ? isTypedArray : constant(false);
diff --git a/modules/mapObject.js b/modules/mapObject.js
@@ -1,8 +1,8 @@
 import cb from './_cb.js';
 import keys from './keys.js';
 
-// Returns the results of applying the iteratee to each element of the object.
-// In contrast to map it returns an object.
+// Returns the results of applying the `iteratee` to each element of `obj`.
+// In contrast to `map` it returns an object.
 export default function mapObject(obj, iteratee, context) {
   iteratee = cb(iteratee, context);
   var _keys = keys(obj),

diff --git a/modules/object.js b/modules/object.js
@@ -2,7 +2,7 @@ import getLength  from './_getLength.js';
 
 // Converts lists into objects. Pass either a single array of `[key, value]`
 // pairs, or two parallel arrays of the same length -- one of keys, and one of
-// the corresponding values. Passing by pairs is the reverse of pairs.
+// the corresponding values. Passing by pairs is the reverse of `pairs`.
 export default function object(list, values) {
   var result = {};
   for (var i = 0, length = getLength(list); i < length; i++) {

diff --git a/modules/partial.js b/modules/partial.js
@@ -3,7 +3,7 @@ import executeBound from './_executeBound.js';
 import _ from './underscore.js';
 
 // Partially apply a function by creating a version that has had some of its
-// arguments pre-filled, without changing its dynamic `this` context. _ acts
+// arguments pre-filled, without changing its dynamic `this` context. `_` acts
 // as a placeholder by default, allowing any combination of arguments to be
 // pre-filled. Set `partial.placeholder` for a custom placeholder argument.
 var partial = restArguments(function(func, boundArgs) {

diff --git a/modules/property.js b/modules/property.js
@@ -3,7 +3,7 @@ import shallowProperty from './_shallowProperty.js';
 import deepGet from './_deepGet.js';
 
 // Creates a function that, when passed an object, will traverse that object’s
-// properties down the given `path`, specified as an array of keys or indexes.
+// properties down the given `path`, specified as an array of keys or indices.
 export default function property(path) {
   if (!isArray(path)) {
     return shallowProperty(path);

diff --git a/modules/random.js b/modules/random.js
@@ -1,4 +1,4 @@
-// Return a random integer between min and max (inclusive).
+// Return a random integer between `min` and `max` (inclusive).
 export default function random(min, max) {
   if (max == null) {
     max = min;

diff --git a/modules/rest.js b/modules/rest.js
@@ -1,8 +1,8 @@
 import { slice } from './_setup.js';
 
-// Returns everything but the first entry of the array. Especially useful on
-// the arguments object. Passing an **n** will return the rest N values in the
-// array.
+// Returns everything but the first entry of the `array`. Especially useful on
+// the `arguments` object. Passing an **n** will return the rest N values in the
+// `array`.
 export default function rest(array, n, guard) {
   return slice.call(array, n == null || guard ? 1 : n);
 }
diff --git a/modules/size.js b/modules/size.js
@@ -1,7 +1,7 @@
 import isArrayLike from './_isArrayLike.js';
 import keys from './keys.js';
 
-// Return the number of elements in an object.
+// Return the number of elements in a collection.
 export default function size(obj) {
   if (obj == null) return 0;
   return isArrayLike(obj) ? obj.length : keys(obj).length;

diff --git a/modules/tap.js b/modules/tap.js
@@ -1,4 +1,4 @@
-// Invokes `interceptor` with the `obj`, and then returns `obj`.
+// Invokes `interceptor` with the `obj` and then returns `obj`.
 // The primary purpose of this method is to "tap into" a method chain, in
 // order to perform operations on intermediate results within the chain.
 export default function tap(obj, interceptor) {

diff --git a/modules/templateSettings.js b/modules/templateSettings.js
@@ -1,6 +1,6 @@
 import _ from './underscore.js';
 
-// By default, Underscore uses ERB-style template delimiters, change the
+// By default, Underscore uses ERB-style template delimiters. Change the
 // following template settings to use alternative delimiters.
 export default _.templateSettings = {
   evaluate: /<%([\s\S]+?)%>/g,

diff --git a/modules/toArray.js b/modules/toArray.js
@@ -6,13 +6,13 @@ import map from './map.js';
 import identity from './identity.js';
 import values from './values.js';
 
-var reStrSymbol = /[^\ud800-\udfff]|[\ud800-\udbff][\udc00-\udfff]|[\ud800-\udfff]/g;
 // Safely create a real, live array from anything iterable.
+var reStrSymbol = /[^\ud800-\udfff]|[\ud800-\udbff][\udc00-\udfff]|[\ud800-\udfff]/g;
 export default function toArray(obj) {
   if (!obj) return [];
   if (isArray(obj)) return slice.call(obj);
   if (isString(obj)) {
-    // Keep surrogate pair characters together
+    // Keep surrogate pair characters together.
     return obj.match(reStrSymbol);
   }
   if (isArrayLike(obj)) return map(obj, identity);

diff --git a/modules/underscore-oop.js b/modules/underscore-oop.js
@@ -3,7 +3,7 @@ import each from './each.js';
 import { ArrayProto } from './_setup.js';
 import chainResult from './_chainResult.js';
 
-// Add all mutator Array functions to the wrapper.
+// Add all mutator `Array` functions to the wrapper.
 each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(name) {
   var method = ArrayProto[name];
   _.prototype[name] = function() {
@@ -18,7 +18,7 @@ each(['pop', 'push', 'reverse', 'shift', 'sort', 'splice', 'unshift'], function(
   };
 });
 
-// Add all accessor Array functions to the wrapper.
+// Add all accessor `Array` functions to the wrapper.
 each(['concat', 'join', 'slice'], function(name) {
   var method = ArrayProto[name];
   _.prototype[name] = function() {
@@ -33,7 +33,7 @@ _.prototype.value = function() {
   return this._wrapped;
 };
 
-// Provide unwrapping proxy for some methods used in engine operations
+// Provide unwrapping proxies for some methods used in engine operations
 // such as arithmetic and JSON stringification.
 _.prototype.valueOf = _.prototype.toJSON = _.prototype.value;
 

diff --git a/underscore-esm.js b/underscore-esm.js
diff --git a/underscore-esm.js.map b/underscore-esm.js.map