Skip to content

Commit

Permalink
Minor code comment
Browse files Browse the repository at this point in the history
  • Loading branch information
benji-glitsos-ga committed Jan 30, 2024
1 parent 0ae8c61 commit d1a6639
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/_static/scripts/headings-behaviour.js
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ document.addEventListener("DOMContentLoaded", function (event) {
let conflictingIdPattern = /id\d+/g;
let customId = maybeCustomIdElement.id;

// Checks that the ID is not 'id1', 'id2', 'id3', or etc. These IDs occur due to a naming conflict between IDs.
// Checks that the ID is not 'id1', 'id2', 'id3', or etc. These IDs occur to prevent a naming conflict between IDs.
// E.g. if a heading 'Introduction' has a '(introduction)=' custom ID above it, this naming conflict will occur.
if (!conflictingIdPattern.test(customId)) {
heading.dataset.anchorId = customId;
Expand Down

0 comments on commit d1a6639

Please sign in to comment.