Added notes for clarification needs in the tests

nicholas-esterer · nicholas-esterer · commit 536e6e951afb · 2021-08-05T17:28:07.000-04:00
diff --git a/src/plots/cartesian/axis_autotype.js b/src/plots/cartesian/axis_autotype.js
@@ -10,6 +10,7 @@ var isDateTime = Lib.isDateTime;
 var cleanNumber = Lib.cleanNumber;
 var round = Math.round;
 
+// Determines a type for an axis based on the contents of array.
 module.exports = function autoType(array, calendar, opts) {
     var a = array;
 
diff --git a/test/jasmine/tests/axes_test.js b/test/jasmine/tests/axes_test.js
@@ -338,7 +338,14 @@ describe('Test axes', function() {
             });
         });
 
+        /* TODO: These tests don't actually test if the numeric strings are
+         * indeed converted or not... */
         describe('autotype disable/enable converting numeric strings', function() {
+            /* TODO: The test description doesn't totally reflect what it is
+             * testing: here the test is to determine that setting
+             * autotypenumbers: 'strict' on the yaxis forces yaxis.type to be
+             * 'category', that's it.
+             */
             it('should disable converting numeric strings using axis.autotypenumbers', function() {
                 layoutIn = {
                     xaxis: {},
@@ -381,7 +388,11 @@ describe('Test axes', function() {
                 expect(layoutOut.yaxis.type).toBe('category');
             });
 
-            it('should autotype date having more dates with & without strict autotypenumbers', function() {
+            /* TODO: Should not the opposite also be tested? Namely that data
+             * having fewer dates gets forced to 'category' (that's consitent
+             * with the previous test).
+             */
+            it('should autotype data having more dates with & without strict autotypenumbers', function() {
                 layoutIn = {
                     xaxis: {},
                     yaxis: { autotypenumbers: 'strict' }
diff --git a/test/jasmine/tests/plot_api_test.js b/test/jasmine/tests/plot_api_test.js
@@ -269,6 +269,8 @@ describe('Test plot api', function() {
             .then(done, done.fail);
         });
 
+        // TODO: Make this test work for the case where categories are numeric
+        // strings
         it('annotations, shapes and images linked to category axes should update properly on zoom/pan', function(done) {
             var jsLogo = 'https://images.plot.ly/language-icons/api-home/js-logo.png';
 
