docs: added info on bookmark return values for securityScopedBookmarks

[rr326]

Description of Change

Dialog.md does not document the expected return values for securityScopedBookmarks. You have to look through the code or old issues to understand how it is supposed to work.

This fixes that.

Checklist

• relevant documentation is changed or added
• PR title follows semantic commit guidelines
• PR release notes describe the change in a way relevant to app developers, and are capitalized, punctuated, and past tense.

Release Notes

Notes: Dialog.md does not document the expected return values for securityScopedBookmarks. You have to look through the code or old issues to understand how it is supposed to work.

[welcome]

💖 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.

[MarshallOfSound]

Can we de-duplicate this information in a single place in this document and just link to it in these 3 places?

[rr326]

That sounds good to me, but I was trying to match the existing convention where it seems to repeat the complete information for every API call.

I'm happy to make the change, but do we need to wait for any other confirmation from others, or do I just do it?

[codebytere]

@rr326 you don't need confirmation, please make the change so we can move this forward!

[rr326]

@codebytere Ok - I think I did this properly. I rebased off of the current version, made my changes, and then pushed to my branch. Please let me know if I did something incorrectly. (First pr.)

[codebytere]

@rr326 looks like it's struggling a bit on the table linting:

AssertionError: We only support plain text, links, softbreaks, inline code, strong tags and paragraphs inside joinable tokens: expected 'table_open' to be one of [ Array(20) ]

if you've cloned Electron locally you can get a shorter feedback loop on this than waiting for CI by running npm run lint:docs on your branch!

[MarshallOfSound]

To fix the above error the table can't be inside a method documentation block. It should be moved to it's own ## level block

[rr326]

Ok - I think I've got it. Note - I noticed an error that one header (showSavedDialog) was incorrect, so I fixed that. It doesn't seem to warrant a whole separate PR process.

[codebytere]

Last thing just looks like:
Trailing whitespace in: /home/builduser/project/src/electron/docs/api/dialog.md

[codebytere]

ah, this just got fixed yesterday actually! You'll see it on rebase

[rr326]

Sorry about that. Maybe I hadn't properly installed my fork. Now it's linting on its own and this one passes. Thanks for your patience.

[codebytere]

thank YOU for the contribution 🚀

review addressed

[zcbenz]

I have rebase this branch on master.

[welcome]

Congrats on merging your first pull request! 🎉🎉🎉

[release-clerk]

Release Notes Persisted

Dialog.md does not document the expected return values for securityScopedBookmarks. You have to look through the code or old issues to understand how it is supposed to work.

[trop]

I have automatically backported this PR to "7-1-x", please check out #21873

[trop]

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