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

docs: fix documented return value for getFocusedWebContents #33170

Merged
merged 1 commit into from Mar 8, 2022

Conversation

kevinushey
Copy link
Contributor

@kevinushey kevinushey commented Mar 7, 2022

Description of Change

Fixes a small documentation issue -- webContents.getFocusedWebContents() can return null, so that value should be part of the return type signature. Thanks to @erickzhao for the assist and pointers.

See also: electron/typescript-definitions#202

Checklist

  • relevant documentation is changed or added

Release Notes

Notes: Fixed the documented return value declared by webContents.getFocusedWebContents() to include null, matching the documented usage of the function.

@welcome
Copy link

welcome bot commented Mar 7, 2022

💖 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 documentation 📓 semver/patch backwards-compatible bug fixes new-pr 🌱 PR opened in the last 24 hours labels Mar 7, 2022
@jkleinsc
Copy link
Contributor

jkleinsc commented Mar 8, 2022

Merging as CI failure unrelated to PR change.

@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Mar 8, 2022
@jkleinsc jkleinsc merged commit 3bc3896 into electron:main Mar 8, 2022
@welcome
Copy link

welcome bot commented Mar 8, 2022

Congrats on merging your first pull request! 🎉🎉🎉

@release-clerk
Copy link

release-clerk bot commented Mar 8, 2022

Release Notes Persisted

Fixed the documented return value declared by webContents.getFocusedWebContents() to include null, matching the documented usage of the function.

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

Successfully merging this pull request may close these issues.

None yet

2 participants