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

Add documentation for Keybinding, KeybindingContribution and KeybindingRegistry #8637

Merged
merged 1 commit into from
Oct 22, 2020

Conversation

JonasHelming
Copy link
Contributor

fixes #8636

Contributed on behalf of STMicroelectronics

Signed-off-by: Jonas Helming jhelming@eclipsesource.com

What it does

Adds/refines documentation for Keybinding, KeybindingContribution, KeyBindingRegistry

How to test

Documentation only

Review checklist

Reminder for reviewers

@JonasHelming JonasHelming changed the title Added documentation for key binding, contributions and registry Add documentation for Keybinding, KeybindingContribution and KeybindingRegistry Oct 15, 2020
@vince-fugnitto vince-fugnitto added documentation issues related to documentation keybindings issues related to keybindings labels Oct 15, 2020
Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

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

@JonasHelming I had a few comments, namely about the use of {@link} and the naming.
I noticed we had multiple different types of representations of the word keybinding that I thought we should align throughout the documentation:

  • keybinding
  • key binding
  • KeyBinding

The single keybinding naming would be sufficient.

packages/core/src/browser/keybinding.ts Outdated Show resolved Hide resolved
packages/core/src/browser/keybinding.ts Show resolved Hide resolved
packages/core/src/browser/keybinding.ts Outdated Show resolved Hide resolved
packages/core/src/browser/keybinding.ts Outdated Show resolved Hide resolved
packages/core/src/browser/keybinding.ts Outdated Show resolved Hide resolved
packages/core/src/common/keybinding.ts Outdated Show resolved Hide resolved
packages/core/src/common/keybinding.ts Outdated Show resolved Hide resolved
packages/core/src/common/keybinding.ts Outdated Show resolved Hide resolved
Copy link
Member

@vince-fugnitto vince-fugnitto left a comment

Choose a reason for hiding this comment

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

@JonasHelming please squash the commits and ensure that there is a proper sign-off (for the eclipse eca check) before we can proceed with an approval.

fixes eclipse-theia#8636

Contributed on behalf of STMicroelectronics

Signed-off-by: Jonas Helming <jhelming@eclipsesource.com>
@JonasHelming
Copy link
Contributor Author

sure, done!

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

Successfully merging this pull request may close these issues.

Add documentation for Keybinding, KeybindingContribution and KeybindingRegistry
3 participants