Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: incorrectly mapped toggleDevTools in custom menu fiddle #40703

Merged

Conversation

Kishanjay
Copy link
Contributor

@Kishanjay Kishanjay commented Dec 5, 2023

Description of Change

Fixes the toggleDevTools call in custom menu fiddle.

It has been wrongly mapped to the BrowserWindow object instead of the webContents object.

Checklist

Release Notes

Notes: Fixed toggleDevTools() code example in documentation.

Copy link

welcome bot commented Dec 5, 2023

💖 Thanks for opening this pull request! 💖

We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix.

Examples of commit messages with semantic prefixes:

  • fix: don't overwrite prevent_default if default wasn't prevented
  • feat: add app.isPackaged() method
  • docs: app.isDefaultProtocolClient is now available on Linux

Things that will help get your PR across the finish line:

  • Follow the JavaScript, C++, and Python coding style.
  • Run npm run lint locally to catch formatting errors earlier.
  • Document any user-facing changes you've made following the documentation styleguide.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Dec 5, 2023
Copy link
Member

@ckerr ckerr left a comment

Choose a reason for hiding this comment

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

Agreed.

History / Trivia: the BrowserWindow call probably works as written, since it has a helper function:

BrowserWindow.prototype.toggleDevTools = function () {
  return this.webContents.toggleDevTools();
};

But according to 80e5007, this is a "Deprecated / undocumented BrowserWindow [method]" so we shouldn't be using it in our docs / examples 😸

@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Dec 12, 2023
@nornagon nornagon merged commit 80d85c0 into electron:main Dec 12, 2023
27 checks passed
Copy link

welcome bot commented Dec 12, 2023

Congrats on merging your first pull request! 🎉🎉🎉

Copy link

release-clerk bot commented Dec 12, 2023

No Release Notes

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

Successfully merging this pull request may close these issues.

None yet

3 participants