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: use "id" instead of "label" for positions #41843

Merged

Conversation

cedrikewers
Copy link
Contributor

@cedrikewers cedrikewers commented Apr 12, 2024

Description of Change

The documentation for the Menu and MenuItem classes describes the constructor options before, after, beforeGroupContaining and afterGroupContaining wrongly. It is said, that the placement would be relative to the MenuItem containing the specified labels. The placement however is relative to a MenuItem with the specified id as shown in the example in the Menu classes documentation. This PR changes the descriptions to reflect this.

Checklist

Release Notes

Notes: none

Copy link

welcome bot commented Apr 12, 2024

💖 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 Apr 12, 2024
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

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

docs: lgtm

Copy link

@electron-docs-reviewer electron-docs-reviewer bot left a comment

Choose a reason for hiding this comment

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

Approving on behalf of the Electron Docs Team

@erickzhao erickzhao added the target/30-x-y PR should also be added to the "30-x-y" branch. label Apr 12, 2024
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Apr 13, 2024
@MarshallOfSound MarshallOfSound merged commit 734395b into electron:main Apr 15, 2024
27 checks passed
Copy link

welcome bot commented Apr 15, 2024

Congrats on merging your first pull request! 🎉🎉🎉

Copy link

release-clerk bot commented Apr 15, 2024

No Release Notes

@trop
Copy link
Contributor

trop bot commented Apr 15, 2024

I have automatically backported this PR to "30-x-y", please check out #41859

@trop trop bot added in-flight/30-x-y merged/30-x-y PR was merged to the "30-x-y" branch. and removed target/30-x-y PR should also be added to the "30-x-y" branch. in-flight/30-x-y labels Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📓 merged/30-x-y PR was merged to the "30-x-y" branch. semver/patch backwards-compatible bug fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants