Skip to content

Commit e50057d

Browse files
authored
Correct comment
1 parent 4c385ce commit e50057d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

pydoctor/themes/base/search.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -465,9 +465,9 @@ window.addEventListener("click", (event) => {
465465
}
466466
});
467467

468-
// Focus on the search bar when the user hit '/' or 'ctrl+k' key, this replaces the default readthedocs search
469-
// box which is not going to include any of the API documentation in its index at the moment. See
470-
// issue #356 for more details.
468+
// Focus on the search bar when the user hit '/' or 'ctrl+k' key, the '/' shortcut is replaced by the default readthedocs search
469+
// box which is not going to include any of the API documentation in its index at the moment (see
470+
// issue #356), this is why we provide another shortcut which is commonly associated to searching.
471471
window.addEventListener('keydown', (event) => {
472472
if((event.key === 'k' && (event.ctrlKey || event.metaKey)) || (event.key === '/' && !event.ctrlKey && !event.metaKey && !event.altKey)){
473473
event.preventDefault();

0 commit comments

Comments
 (0)