Clarified comments for the heading calculations

GSA · May 15, 2024 · dbc2094 · dbc2094
1 parent 4c7e1d2
commit dbc2094
Showing 1 changed file with 3 additions and 3 deletions.
diff --git a/themes/digital.gov/src/js/guide-sidenav.js b/themes/digital.gov/src/js/guide-sidenav.js
@@ -154,12 +154,12 @@ function findTopHeading(
 
   // Recursive case
   /* eslint-disable no-param-reassign */
-  // Calculate the distance of the current heading fro the top of the page
-  // getBoundingClientRect().top gives the distance from the viewport, so we add the scrollY to get the distance from the top of the page
+  // Calculate the distance of the current heading from the top of the page
+  // getBoundingClientRect().top gives the distance from the element to the top of the viewport, then we add the scrollY to get the distance from the top of the viewport to the top of the page
   const currentHeadingTop =
     headings[i].getBoundingClientRect().top + window.scrollY;
 
-  //  Calculate the distance of the next heading from the top of the document, if there is a next heading
+  // Calculate the distance of the next heading from the top of the document, if there is a next heading
   // If there is no next heading, set nextHeadingTop to Infinity
   const nextHeadingTop =
     i < headings.length - 1