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] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page + removed trailing whitespaces #10391

Merged
merged 4 commits into from
Sep 26, 2020

Conversation

precondition
Copy link
Contributor

@precondition precondition commented Sep 21, 2020

Description

I corrected the incorrect "this repeats the tapped key rather to hold a modifier key." and used the opportunity to reword that paragraph in the Tapping Force Hold section a bit to make it clearer what is the default behaviour, and contrasted it with the TAPPING_FORCE_HOLD behaviour and let it know that it applies to all dual-role keys, not just mod-taps.

Additionally, I also formatted the example by putting the pressed keys between backticks as done everywhere else in the Tap Hold configuration settings documentation page.

Then, I also replaced the "tapping" in "One Shot Tapping Toggle" by simply "tap" because that's what the One-Shot documentation page uses exclusively.

Finally, I removed the quotes around the word "tapping" in the "tapping" function because they're unnecessary.

EDIT: A second commit removing all trailing whitespaces in the Tap Hold configuration settings page was added.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

  • N/A

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes
around "tapping".
@precondition precondition changed the title [Docs] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page [Docs] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page + removed trailing whitespaces Sep 21, 2020
@drashna drashna requested a review from a team September 22, 2020 05:00
Copy link
Contributor

@ridingqwerty ridingqwerty left a comment

Choose a reason for hiding this comment

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

Made one little suggestion, but overall I think this does a good job correcting some grammar errors and explaining these feature.

docs/tap_hold.md Outdated Show resolved Hide resolved
Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs.

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
Copy link
Contributor

@ridingqwerty ridingqwerty left a comment

Choose a reason for hiding this comment

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

Looks good.

@ridingqwerty
Copy link
Contributor

Thanks!

@ridingqwerty ridingqwerty merged commit 28ff511 into qmk:master Sep 26, 2020
@precondition precondition deleted the tapping-force-hold-docs branch September 27, 2020 11:42
tomohisa pushed a commit to tomohisa/qmk_firmware that referenced this pull request Sep 28, 2020
* 'master' of https://github.com/qmk/qmk_firmware: (3643 commits)
  Swapparoo of bottom row keys (qmk#10277)
  [Keyboard] Add PloopyCo devices (qmk#7935)
  Keyboard update: SL40 (qmk#10445)
  [keyboard] Add SP-111 support (qmk#10193)
  Add logic for AT90USBxx7 where needed (qmk#10203)
  Trifecta Keymap
  [Docs] Wording & formatting changes in the Tapping Force Hold section of the Tap Hold page + removed trailing whitespaces (qmk#10391)
  `setrgb()`: Use arrow operator (qmk#10451)
  [Keyboard] add Percent Canoe Gen2 (qmk#10344)
  [Keyboard] add hannah65 by Team Mechlovin (qmk#10284)
  Fix Belgian sendstring properly (qmk#10444)
  Add VIA support for lazydesigners/the30 (qmk#10374)
  [Keyboard] add duckboard by doodboard (qmk#10318)
  Fix Belgian sendstring file (qmk#10443)
  [Keyboard] added Bolsa65 keyboard by FJLabs (qmk#10394)
  CLI/Doctor: Print QMK_HOME (qmk#10398)
  Add Wyvern Keyboard (qmk#10378)
  Adding Bear 65 Ergo Keyboard To QMK (qmk#10384)
  VIA Support: Gray Studio HB85 (qmk#10329)
  format code according to conventions [skip ci]
  ...
rgoulter pushed a commit to rgoulter/qmk_firmware that referenced this pull request Oct 4, 2020
… of the Tap Hold page + removed trailing whitespaces (qmk#10391)

* Wording & formatting changes in Tapping Force Hold

The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes
around "tapping".

* Removed all trailing whitespaces from tap hold doc

* "it's simply really:" → "it's simple really:"

* "This allows to keep the ability" → "This allows keeping the ability"

Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs.

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
kjganz pushed a commit to kjganz/qmk_firmware that referenced this pull request Oct 28, 2020
… of the Tap Hold page + removed trailing whitespaces (qmk#10391)

* Wording & formatting changes in Tapping Force Hold

The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes
around "tapping".

* Removed all trailing whitespaces from tap hold doc

* "it's simply really:" → "it's simple really:"

* "This allows to keep the ability" → "This allows keeping the ability"

Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs.

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
… of the Tap Hold page + removed trailing whitespaces (qmk#10391)

* Wording & formatting changes in Tapping Force Hold

The Permissive Hold and the Ignore Mod Tap Interrupt sections were also modified to remove the quotes
around "tapping".

* Removed all trailing whitespaces from tap hold doc

* "it's simply really:" → "it's simple really:"

* "This allows to keep the ability" → "This allows keeping the ability"

Used the gerund form of "to keep" in the Tapping Force Hold section of the Tap Hold docs.

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>

Co-authored-by: ridingqwerty <george.g.koenig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants