flatpak / xdg-desktop-portal

Desktop integration portal
https://flatpak.github.io/xdg-desktop-portal/
GNU Lesser General Public License v2.1
577 stars 188 forks source link

Undocumented options in GlobalShortcuts::Activated #1312

Open dcz-self opened 6 months ago

dcz-self commented 6 months ago

Operating System

n/a

XDG Desktop Portal version

Git

XDG Desktop Portal version (Other)

No response

Desktop Environment

Other

Desktop Environment (Other)

No response

Expected Behavior

APIs are clear to use and implement.

Current Behavior

There's an undocumented options argument in GlobalShortcuts::Activated and ::Deactivated signals. This makes implementing the signals correctly a puzzle.

Steps to Reproduce

  1. Go to org-freedesktop-portal-globalshortcuts-activated and -deactivated
  2. Notice "options" parameter
  3. Notice content-free description in the following lines

Anything else we should know?

No response

matthiasclasen commented 3 months ago

Yeah. It would be good to document it as currently unused.