Skip to content

Conversation

@Lk-ux
Copy link
Contributor

@Lk-ux Lk-ux commented Nov 8, 2025

No description provided.

@javascript-translate-bot javascript-translate-bot added the review needed Review needed, please approve or request changes label Nov 8, 2025
@javascript-translate-bot javascript-translate-bot requested a review from a team November 8, 2025 11:00
@CLAassistant
Copy link

CLAassistant commented Nov 8, 2025

CLA assistant check
All committers have signed the CLA.

@smith558 smith558 requested a review from Copilot November 12, 2025 20:26
Copilot finished reviewing on behalf of smith558 November 12, 2025 20:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the Mac hotkey documentation for code commenting in a JavaScript tutorial article, changing from a generic substitution instruction to specific key combinations.

Key Changes:

  • Replaces generic Mac modifier key substitution guidance with explicit hotkey combinations
  • Specifies Cmd+/ for single-line comments on Mac
  • Adds Option+Shift+A as the VS Code multiline comment hotkey for Mac

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.


```smart header="Use hotkeys!"
In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` -- for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd` instead of `key:Ctrl` and `key:Option` instead of `key:Shift`.
In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` -- for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd+/` for single-line comments and `key:Option+Shift+A` (on VS Code) for multiline comments.
Copy link

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The multiline comment hotkey documentation has inconsistencies:

  1. Editor specificity: Adding "(on VS Code)" only for multiline comments is inconsistent since the earlier part of the sentence refers to "most editors" without specifying which one. This creates confusion about whether the Mac instructions apply generally or only to VS Code.

  2. Key order: The standard convention is to list modifier keys in order (Shift before Option), so it should be key:Shift+Option+A rather than key:Option+Shift+A.

  3. Incomplete information: If you're going to specify VS Code for multiline comments, you should clarify what applies to other editors. Alternatively, provide the general Mac equivalent like the original approach, or note that multiline comment hotkeys vary by editor.

Consider revising to either:

  • Keep it general: "For Mac, try key:Cmd+/ for single-line comments and key:Cmd+Option+/ or key:Shift+Option+A for multiline comments (varies by editor)."
  • Or be consistent about editor-specificity throughout the sentence.
Suggested change
In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` -- for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd+/` for single-line comments and `key:Option+Shift+A` (on VS Code) for multiline comments.
In most editors, a line of code can be commented out by pressing the `key:Ctrl+/` hotkey for a single-line comment and something like `key:Ctrl+Shift+/` for multiline comments (select a piece of code and press the hotkey). For Mac, try `key:Cmd+/` for single-line comments and `key:Cmd+Option+/` or `key:Shift+Option+A` for multiline comments (hotkeys may vary by editor).

Copilot uses AI. Check for mistakes.
@smith558
Copy link
Member

@Lk-ux please check some of the comments

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

review needed Review needed, please approve or request changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants