Aditi16-ctrl

#53172: docs: update documentation for menuItem.registerAccelerator

Merged
Created: Aug 25, 2026, 5:35:38 AM
Merged: Aug 26, 2026, 11:06:18 AM
5 comments
Target: main

Description of Change

Added the platform availability badge (_Linux_ _Windows_) to the
menuItem.registerAccelerator instance property documentation in
docs/api/menu-item.md.

This change aligns the instance property documentation with the
constructor options section, where registerAccelerator is already
documented as being available only on Linux and Windows.

The update resolves an inconsistency that could cause confusion about
whether menuItem.registerAccelerator is supported on macOS.

Fixes #53123

Checklist

  • I have built and tested this change
  • I have filled out the PR description
  • I have reviewed and verified the changes
  • npm test passes
  • tests are changed or added
  • relevant API documentation, tutorials, and examples are updated and follow the documentation style guide
  • PR release notes describe the change in a way relevant to app developers

Release Notes

Notes: none

Backports

42-x-y
Merged
PR Number
#53207
Merged At
Aug 26, 2026, 12:05:18 PM
Released In
Not yet
Release Date
Not yet
43-x-y
Merged
PR Number
#53209
Merged At
Aug 26, 2026, 12:05:12 PM
Released In
Not yet
Release Date
Not yet
44-x-y
Merged
PR Number
#53208
Merged At
Aug 26, 2026, 12:05:15 PM
Released In
Not yet
Release Date
Not yet

Semver Impact

Major
Breaking changes
Minor
New features
Patch
Bug fixes
None
Docs, tests, etc.

Semantic Versioning helps users understand the impact of updates:

  • Major (X.y.z): Breaking changes that may require code modifications
  • Minor (x.Y.z): New features that maintain backward compatibility
  • Patch (x.y.Z): Bug fixes that don't change the API
  • None: Changes that don't affect using facing parts of Electron