all comments added#360
Merged
Merged
Conversation
Closed
3 tasks
Contributor
There was a problem hiding this comment.
Pull request overview
Adds/updates JSDoc-compliant documentation across templates/js to improve developer onboarding and make function/class intent, parameters, and return types clearer (per #213).
Changes:
- Added/expanded JSDoc blocks for key exported functions and several internal helpers (including
@param/@returns). - Improved inline documentation for UI modules (sidebar, search, navigation, quiz).
- Added type documentation for shared data structures (e.g.,
imageCaptionsmap).
Reviewed changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| templates/js/viewer.js | Adds missing @returns and improves parameter doc for viewer display helpers. |
| templates/js/sidebar.js | Adds JSDoc for async sidebar/help-button initialization functions. |
| templates/js/search.js | Adds JSDoc for search initialization and internal search/navigation helpers. |
| templates/js/quiz.js | Adds class/method JSDoc for quiz manager behavior and return types. |
| templates/js/navigation.js | Documents navigation setup and helper functions with parameter/return types. |
| templates/js/main.js | Adds JSDoc for populateSubboneDropdown (but currently has a malformed/duplicated block). |
| templates/js/imageDisplay.js | Adds JSDoc for image rendering helpers and transform utilities. |
| templates/js/imageCaptions.js | Documents exported caption lookup map type/shape. |
| templates/js/dropdowns.js | Adds JSDoc for image stage helpers, image-loading helper, and dropdown wiring. |
| templates/js/description.js | Adds JSDoc for GitHub-backed description loader. |
| templates/js/coloredRegionsOverlay.js | Adds missing @returns tags for clear helpers. |
| templates/js/api.js | Adds JSDoc for API fetch functions including throws/return details. |
| templates/js/annotationOverlay.js | Adds JSDoc for overlay lifecycle and annotation rendering/loading helpers (one doc mismatch with implementation). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
leandrumartin
requested changes
May 2, 2026
# Conflicts: # templates/js/annotationOverlay.js # templates/js/api.js # templates/js/dropdowns.js # templates/js/imageDisplay.js # templates/js/quiz.js # templates/js/sidebar.js
leandrumartin
approved these changes
Jun 16, 2026
# Conflicts: # templates/js/annotationOverlay.js
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #213
Add JSDoc-compliant comments to files that lack sufficient documentation.