Skip to content

Commit 7a66493

Browse files
committed
fix comment formatting
1 parent f551411 commit 7a66493

1 file changed

Lines changed: 12 additions & 8 deletions

File tree

javascripts/toggle-images.js

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ const hideImagesByDefault = false
77
// Set the image placeholder icon here.
88
const placeholderImagePath = '/assets/images/octicons/image.svg'
99

10-
// This module does a few things:
11-
//
12-
// 1. Wraps every image in a button so they can be toggled individually.
13-
// 2. Adds a new icon button in the margin to toggle all images on the page.
14-
//
15-
// It uses cookies to keep track of a user's selected image preference.
10+
/*
11+
* This module does two main things:
12+
* 1. Wraps every image in a button so they can be toggled individually.
13+
* 2. Adds a new icon button in the margin to toggle all images on the page.
14+
* It uses cookies to keep track of a user's selected image preference.
15+
*/
1616
export default function () {
1717
const toggleImagesBtn = document.getElementById('js-toggle-images')
1818
if (!toggleImagesBtn) return
@@ -30,7 +30,9 @@ export default function () {
3030
// Look for a cookie with image visibility preference; otherwise, use the default.
3131
const hideImagesPreferred = (Cookies.get('hideImagesPreferred') === 'true') || hideImagesByDefault
3232

33-
/* 1. INDIVIDUAL IMAGE HANDLING */
33+
/*
34+
* 1. INDIVIDUAL IMAGE HANDLING
35+
*/
3436

3537
// Get the aria-labels from the span elements containing the hide/show tooltips for single images.
3638
// (We do it this way instead of hardcoding text in JS for localization friendliness.)
@@ -75,7 +77,9 @@ export default function () {
7577
})
7678
}
7779

78-
/* 2. PAGE-WIDE TOGGLE BUTTON HANDLING */
80+
/*
81+
* 2. PAGE-WIDE TOGGLE BUTTON HANDLING
82+
*/
7983

8084
// Get the span elements containing the off and on icons.
8185
const offIcon = document.getElementById('js-off-icon')

0 commit comments

Comments
 (0)