Comment multi_select.js

aleksis/core/static/js/multi_select.js

 $(document).ready(function () {
     $("#select_all_container").show();
     $("#header_box").change(function () {
+        /*
+        If the top checkbox is checked, all sub checkboxes should be checked,
+        if it gets unchecked, all other ones should get unchecked.
+        */
         if ($(this).is(":checked")) {
             $(document).find('input[name="selected_objects"]').prop({
                 indeterminate: false,
@@ -15,10 +19,17 @@ $(document).ready(function () {
     });
 
     $('input[name="selected_objects"]').change(function () {
+        /*
+        If a table checkbox changes, check the state of the other ones.
+        If all boxes are checked the box in the header should be checked,
+        if all boxes are unchecked the header box should be unchecked. If
+        only some boxes are checked the top one should be inderteminate.
+         */
         let checked = $(this).is(":checked");
         let indeterminate = false;
         $(document).find('input[name="selected_objects"]').each(function () {
             if ($(this).is(":checked") !== checked) {
+                /* Set the header box to indeterminate if the boxes are not the same */
                 $("#header_box").prop({
                     indeterminate: true,
                 })
@@ -27,6 +38,7 @@ $(document).ready(function () {
             }
         });
         if (!(indeterminate)) {
+            /* All boxes are the same, set the header box to the same value */
             $("#header_box").prop({
                 indeterminate: false,
                 checked: checked,