tweaked some comments

kollavarsham · Sep 17, 2015 · e86f718 · e86f718
1 parent 1ac36a6
commit e86f718
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/lib/calculations.js b/lib/calculations.js
@@ -118,17 +118,17 @@ class Calculations {
 
     calendarData.adhimasa = Calendar.getAdhimasa(lastConjunctionLongitude, nextConjunctionLongitude);
     calendarData.masaNum = Calendar.getMasaNum(trueSolarLongitude, lastConjunctionLongitude);
-    // TODO: Move the below function to within KollavarshamDate class
+    // TODO: Move below to within KollavarshamDate class
     calendarData.masa = Calendar.getMasaName(calendarData.masaNum).saka;
 
     const sauraMasaMonthDay = this.calendar.getSauraMasaMonthDay(ahargana, desantara);
     const sauraMasaNum = sauraMasaMonthDay.month;
     const sauraMasaDay = sauraMasaMonthDay.day;
-    // TODO: Move the below function to within KollavarshamDate class
+    // TODO: Move below to within KollavarshamDate class
     calendarData.sauraMasa = Calendar.getMasaName(sauraMasaNum).saura;
 
     calendarData.malayalaMasaNum = (sauraMasaNum - 4 + 12 ) % 12;
-    // TODO: Move the below function to within KollavarshamDate class
+    // TODO: Move below to within KollavarshamDate class
     const malayalaMasa = Calendar.getMasaName(calendarData.malayalaMasaNum);
     calendarData.malayalaMasa = malayalaMasa.enMalayalam;
     calendarData.mlMalayalaMasa = malayalaMasa.mlMalayalam;

diff --git a/lib/calendar.js b/lib/calendar.js
@@ -104,7 +104,7 @@ class Calendar {
   }
 
   nextDate(date) {
-    // TODO: This looks like a concern of the calling library - But could be exposed as a static utility function  (0 usages other than tests)
+    // TODO: This looks like a concern of the calling library - But could be exposed as a static utility method (0 usages other than tests)
     date.setUTCDate(date.getUTCDate() + 1);
     return date;
   }
@@ -140,13 +140,13 @@ class Calendar {
   }
 
   julianInEngland(julianDay) {
-    // TODO: This might be exposed as a static utility function (0 usages other than tests)
+    // TODO: This might be exposed as a static utility method (0 usages other than tests)
     // Gregorian calendar was first introduced in most of Europe in 1582,
     // but it wasn't adopted in England (and so in US and Canada) until 1752
     //
     // - http://www.timeanddate.com/calendar/julian-gregorian-switch.html
     //
-    // This function returns true between
+    // This returns true between
     //      October 14th, 1582 and September 14th, 1752, both dates exclusive
     return julianDay >= 2299160 && julianDay <= 2361221;
   }

diff --git a/lib/index.js b/lib/index.js
@@ -169,7 +169,7 @@ class Kollavarsham {
    * @throws {Error} When the API is implemented, will convert <date>
    */
   toGregorianDate(date) {
-    //TODO: Implement this function
+    //TODO: Implement this method
     throw new Error(util.format('When the API is implemented, will convert %s', date));
   }
 

diff --git a/lib/mathHelper.js b/lib/mathHelper.js
@@ -10,6 +10,7 @@ const _epsilon = 1e-8; // eslint-disable-line no-underscore-dangle
 const _radianInDegrees = 180 / Math.PI; // eslint-disable-line no-underscore-dangle
 
 class MathHelper {
+
   static get epsilon() {
     return _epsilon;
   }
@@ -73,6 +74,7 @@ class MathHelper {
     const result = angleInDegrees - MathHelper.truncate(angleInDegrees / 360) * 360;
     return result < 0 ? 360 + result : result;
   }
+
 }
 
 export default MathHelper;