From 40204e8133d033d91eba4d327426e610002d6909 Mon Sep 17 00:00:00 2001 From: John-David Dalton Date: Sun, 15 Sep 2013 17:17:57 -0700 Subject: [PATCH] Cleanup docs. --- README.md | 3 +-- doc/README.md | 12 ++++++------ vendor/benchmark.js/benchmark.js | 14 -------------- vendor/docdown/src/DocDown/Entry.php | 5 ++++- 4 files changed, 11 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 720758692..63ded3ca4 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,9 @@ A utility library delivering consistency, [customization](http://lodash.com/cust [Development](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.underscore.js) & [Production](https://raw.github.com/lodash/lodash/2.0.0/dist/lodash.underscore.min.js) -Love modules? We’ve got you covered with [lodash-amd](https://npmjs.org/package/lodash-amd), [lodash-node](https://npmjs.org/package/lodash-node), and [npm packages](https://npmjs.org/browse/author/jdalton) per method. - CDN copies are available on [cdnjs](http://cdnjs.com/) & [jsDelivr](http://www.jsdelivr.com/#!lodash).
For smaller file sizes, create [custom builds](http://lodash.com/custom-builds) with only the features needed. +Love modules? We’ve got you covered with [lodash-amd](https://npmjs.org/package/lodash-amd), [lodash-node](https://npmjs.org/package/lodash-node), and [npm packages](https://npmjs.org/browse/author/jdalton) per method. ## Dive in diff --git a/doc/README.md b/doc/README.md index 50bfcd126..9ce7fff60 100644 --- a/doc/README.md +++ b/doc/README.md @@ -107,14 +107,14 @@ * [`_.compose`](#_composefunc) * [`_.createCallback`](#_createcallbackfuncidentity--thisarg--argcount) * [`_.curry`](#_curryfunc--arityfunclength) -* [`_.debounce`](#_debouncefunc-wait--options--optionsleadingfalse--optionsmaxwait--optionstrailingtrue) +* [`_.debounce`](#_debouncefunc-wait--options--optionsmaxwait) * [`_.defer`](#_deferfunc--arg) * [`_.delay`](#_delayfunc-wait--arg) * [`_.memoize`](#_memoizefunc--resolver) * [`_.once`](#_oncefunc) * [`_.partial`](#_partialfunc--arg) * [`_.partialRight`](#_partialrightfunc--arg) -* [`_.throttle`](#_throttlefunc-wait--options--optionsleadingtrue--optionstrailingtrue) +* [`_.throttle`](#_throttlefunc-wait--options) * [`_.wrap`](#_wrapvalue-wrapper) @@ -2388,8 +2388,8 @@ curried(1, 2, 3); -### `_.debounce(func, wait, [options], [options.leading=false], [options.maxWait], [options.trailing=true])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5433 "View in source") [Ⓣ][1] +### `_.debounce(func, wait, [options], [options.maxWait])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5433 "View in source") [Ⓣ][1] Creates a function that will delay the execution of `func` until after `wait` milliseconds have elapsed since the last time it was invoked. Provide an options object to indicate that `func` should be invoked on the leading and/or trailing edge of the `wait` timeout. Subsequent calls to the debounced function will return the result of the last `func` call. @@ -2614,8 +2614,8 @@ options.imports -### `_.throttle(func, wait, [options], [options.leading=true], [options.trailing=true])` -# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5747 "View in source") [Ⓣ][1] +### `_.throttle(func, wait, [options])` +# [Ⓢ](https://github.com/bestiejs/lodash/blob/master/lodash.js#L5747 "View in source") [Ⓣ][1] Creates a function that, when executed, will only call the `func` function at most once per every `wait` milliseconds. Provide an options object to indicate that `func` should be invoked on the leading and/or trailing edge of the `wait` timeout. Subsequent calls to the throttled function will return the result of the last `func` call. diff --git a/vendor/benchmark.js/benchmark.js b/vendor/benchmark.js/benchmark.js index 02e58ad7e..835e9d5db 100644 --- a/vendor/benchmark.js/benchmark.js +++ b/vendor/benchmark.js/benchmark.js @@ -553,20 +553,6 @@ (/^[\s(]*function[^(]*\(([^\s,)]+)/.exec(fn) || 0)[1]) || ''; } - /** - * Computes the geometric mean (log-average) of a sample. - * See http://en.wikipedia.org/wiki/Geometric_mean#Relationship_with_arithmetic_mean_of_logarithms. - * - * @private - * @param {Array} sample The sample. - * @returns {number} The geometric mean. - */ - function getGeometricMean(sample) { - return pow(Math.E, _.reduce(sample, function(sum, x) { - return sum + log(x); - }) / sample.length) || 0; - } - /** * Computes the arithmetic mean of a sample. * diff --git a/vendor/docdown/src/DocDown/Entry.php b/vendor/docdown/src/DocDown/Entry.php index e1e7b56a4..3108aaede 100644 --- a/vendor/docdown/src/DocDown/Entry.php +++ b/vendor/docdown/src/DocDown/Entry.php @@ -142,7 +142,10 @@ class Entry { $params = $this->getParams(); foreach ($params as $param) { - $result[] = $param[1]; + // skip params that are properties of other params (e.g. `options.leading`) + if (!preg_match('/\w+\.[\w.]+\s*=/', $param[1])) { + $result[] = $param[1]; + } } // format $result = $name .'('. implode(array_slice($result, 1), ', ') .')';