fix typos in comments

This commit is contained in:
Valentin Gagarin 2022-11-09 00:49:34 +01:00
parent 8dd5ba2f47
commit daedaa197d

View file

@ -2,12 +2,12 @@
// this must be done on the client side, as web servers do not see the anchor part of the URL. // this must be done on the client side, as web servers do not see the anchor part of the URL.
// redirections are declared as follows: // redirections are declared as follows:
// each entry has as key the matched URL path relative to the mdBook document root. // each entry has as its key a path matching the requested URL path, relative to the mdBook document root.
// //
// IMPORTANT: it must specify the full path with file name and suffix // IMPORTANT: it must specify the full path with file name and suffix
// //
// each entry is a set of key-value pairs, where // each entry is itself a set of key-value pairs, where
// - keys are anchors on to the matched path. // - keys are anchors on the matched path.
// - values are redirection targets relative to the current path. // - values are redirection targets relative to the current path.
const redirects = { const redirects = {
@ -352,16 +352,16 @@ const redirects = {
// //
// matching URLs is more involved than it should be: // matching URLs is more involved than it should be:
// //
// 1. `document.location.pathname` can have an have an arbitrary prefix. // 1. `document.location.pathname` can have an arbitrary prefix.
// //
// 2. `path_to_root` is set by mdBook and consists only of `../`s and // 2. `path_to_root` is set by mdBook. it consists only of `../`s and
// determines the depth of `<path>` relative to the prefix: // determines the depth of `<path>` relative to the prefix:
// //
// `document.location.pathname` // `document.location.pathname`
// |------------------------------| // |------------------------------|
// /<prefix>/<path>/[<file>[.html]][#<anchor>] // /<prefix>/<path>/[<file>[.html]][#<anchor>]
// |----| // |----|
// `path_to_root` has same number of segments // `path_to_root` has same number of path segments
// //
// source: https://phaiax.github.io/mdBook/format/theme/index-hbs.html#data // source: https://phaiax.github.io/mdBook/format/theme/index-hbs.html#data
// //
@ -410,7 +410,9 @@ const path = segments.join('/');
// anchor starts with the hash character (`#`), // anchor starts with the hash character (`#`),
// but our redirect declarations don't, so we strip it. // but our redirect declarations don't, so we strip it.
// example: document.location.hash -> '#foo' // example:
// document.location.hash -> '#foo'
// document.location.hash.substring(1) -> 'foo'
const anchor = document.location.hash.substring(1); const anchor = document.location.hash.substring(1);
const redirect = redirects[path]; const redirect = redirects[path];