code review
[dygraphs.git] / datahandler / datahandler.js
index 0261794..b3eae91 100644 (file)
@@ -103,7 +103,8 @@ handler.prototype.extractSeries = function(rawData, seriesIndex, options) {
 };
 
 /**
- * Converts a series to a Point array.
+ * Converts a series to a Point array.  The resulting point array must be
+ * returned in increasing order of idx property.
  * 
  * @param {!Array.<[!number,?number,?]>} series The series in the unified 
  *          data format where series[i] = [x,y,{extras}].
@@ -161,7 +162,6 @@ handler.prototype.onPointsCreated_ = function(series, points) {
  *          data format where series[i] = [x,y,{extras}].
  * @param {!number} rollPeriod The number of points over which to average the data
  * @param {!DygraphOptions} options The dygraph options.
- * TODO(danvk): be more specific than "Array" here.
  * @return {!Array.<[!number,?number,?]>} the rolled series.
  */
 handler.prototype.rollingAverage = function(series, rollPeriod, options) {
@@ -255,6 +255,7 @@ handler.prototype.getIndexesInWindow_ = function(series, dateWindow) {
  * all values were type number, with few edge cases, none of which were strings.
  * @param {?number} val
  * @return {number}
+ * @protected
  */
 handler.parseFloat = function(val) {
   // parseFloat(null) is NaN