MicrosoftDocs / terminal

Creative Commons Attribution 4.0 International
472 stars 182 forks source link

Section on "keys" key misleading/inaccurate/not fully implemented #187

Closed atimholt closed 3 years ago

atimholt commented 3 years ago

On this page of Windows Terminal's documentation, under the heading “keys” (as directly linked in the below automatically-included “Document Details”), the documentation states that “[key] defines the key combinations used to call the command”—note the plural on the word “combinations”. Also note that this does not state “combination of keys”—it is quite plain that this unambiguously states that multiple separate key combinations can be set using this key.

Furthermore, the documentation here states that the key “key” “Accepts: String or array[string]”. As of Windows Terminal 1.4.3141.0 (the latest stable version as of this writing), “key” does indeed accept an “array[string]”, but returns this error upon trying to save your settings with an array with more than one element here (as a pop-up if Windows Terminal is open):

Warnings were found while parsing your keybindings:

  • Found a keybinding with too many strings for the "keys" array. There should only be one string value in the "keys" array.

Personally, I'd prefer it if the feature were implemented, rather than just a correction being made to the documentation, but I imagine fixing the documentation is quicker, and more urgent though less important.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

zadjii-msft commented 3 years ago

technically, it will accept an array with one element 😉 We're leaving the array parsing in for now, since we do plan on coming back to adding support for key chords - see microsoft/terminal#1334

mattwojo commented 3 years ago

Sounds like this does not require an update to the docs. Closing. (Please reopen if this changes.)