Add more comments, especially for calculation functions

ua-snap / financial-framework-tool

UA Financial Framework Visualization Tool

2 stars 0 forks source link

Add more comments, especially for calculation functions #43

Open cstephen opened 7 years ago

cstephen commented 7 years ago

In particular I found this part of AppropriationsGraph.vue difficult to follow even after looking up _.invokeMap()'s documentation:

processData: function (field, y1, y2) {
  var data = _.concat(
    this[field + '2016'],
    this[field + '2018'],
    this[field + '2019'],
    this[field + '2020'],
    _.invokeMap(
      [2021, 2022, 2023, 2024],
      interpolate,
      this[field + '2020'],
      this[field + '2025'],
      5,
      2020
    ),
    this[field + '2025']
  )
  return data
},

brucecrevensten commented 7 years ago

Also, add comments regarding other internal calculations for the "spreadsheet" -- they're very simple, and it'd aid understanding of the application to have that documented in the code.