Merge pull request #34 from comphy-lab/coderabbitai/docstrings/ed3c21a

📝 Add docstrings to `vs-branch-6`

Author: VatsalSy

.github/assets/js/shortcut-key.js

@@ -1,6 +1,15 @@
 document.addEventListener('DOMContentLoaded', function() {
   // Platform detection is now handled by platform-utils.js
-  // Update the displayed shortcut text is now handled by platform-utils.js
+  /**
+   * Dynamically loads a stylesheet into the document's head.
+   *
+   * Creates a <link> element with the specified URL, sets attributes necessary for secure loading,
+   * and appends it to the document's head. If the stylesheet fails to load, an error is logged
+   * to the console.
+   *
+   * @param {string} href - The URL of the stylesheet to be loaded.
+   * @returns {HTMLLinkElement} The created and appended link element.
+   */
 
   function loadStylesheet(href) {
     const link = document.createElement('link');

assets/js/platform-utils.js

@@ -9,7 +9,13 @@ function isMacPlatform() {
 }
 
 /**
- * Update UI elements based on platform (Mac vs non-Mac)
+ * Updates UI elements to reflect the user's platform.
+ *
+ * This function determines whether the current platform is a Mac by calling `isMacPlatform()`
+ * and adjusts the visibility of UI elements accordingly:
+ * - Elements with the class `.default-theme-text` are hidden on Mac platforms.
+ * - Elements with the class `.mac-theme-text` are shown on Mac platforms.
+ * On non-Mac platforms, the visibility settings are reversed.
  */
 function updatePlatformSpecificElements() {
   const isMac = isMacPlatform();