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.

Sign up for GitHub

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

Jump to bottom

Tidy up dztech default keymaps and info.json #7608

Merged
merged 1 commit into from
Dec 17, 2019
Merged

Tidy up dztech default keymaps and info.json #7608

merged 1 commit into from
Dec 17, 2019

Conversation

fauxpark
Copy link
Member

Description

Mostly whitespace/alignment. I have more queued for the rest of the keyboard code.

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

Checklist

  • My code follows the code style of this project.
  • 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).

@fauxpark fauxpark requested a review from a team December 12, 2019 01:51
@drashna drashna requested a review from a team December 12, 2019 03:39
noroadsleft
noroadsleft approved these changes Dec 12, 2019
View reviewed changes
Copy link
Member

@noroadsleft noroadsleft left a comment

Choose a reason for hiding this comment

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

I prefer if the key_count and label keys are present in info.json files, but everything's still accurate.

@fauxpark
Copy link
Member Author

I don't quite understand the point of them, really. key_count could/should be dynamically calculated based on the number of elements in the object? And as for the labels, shouldn't info.json just define the geometry of the layout?

@noroadsleft
Copy link
Member

It makes the files easier to debug if there are problems.

key_count can be dynamically calculated, but explicitly saying how many keys there should be makes it easier to check for mismatches. label makes it easier to identify keys at a glance if they're incorrectly positioned or out of sequence.

@fauxpark
Copy link
Member Author

Sure, but when a decent GUI editor comes along it'll render that pretty much useless, right? Since if you're missing a key or have one too many it would be fairly obvious. And what about layouts that don't resemble the typical ANSI/ISO format? I guess I just don't see why info.json should have an opinion on which keys "do" what, unless the goal for it is to also include a default set of keycodes or something.

@noroadsleft
Copy link
Member

Sure, but when a decent GUI editor comes along it'll render that pretty much useless, right? Since if you're missing a key or have one too many it would be fairly obvious.

A GUI editor IMO only solves this if two things happen:

  1. Said editor also checks the key count given in the keyboard.h file
  2. Said editor also lets you edit the JSON directly for solving out-of-sequence issues (think ISO Enter being on QWERTY Row vs. Home Row)

I guess I just don't see why info.json should have an opinion on which keys "do" what, unless the goal for it is to also include a default set of keycodes or something.

It doesn't; it's mainly for the human reading the file, though yanfali and I did recently discuss the possibility of doing exactly what you've described.

@fauxpark fauxpark mentioned this pull request Dec 16, 2019
Merged
13 tasks
@fauxpark fauxpark merged commit 1ac9958 into qmk:master Dec 17, 2019
@fauxpark fauxpark deleted the dztech-default-keymaps-tidy branch December 17, 2019 23:15
benjaminmikiten added a commit to benjaminmikiten/qmk_firmware that referenced this pull request Dec 18, 2019
@benjaminmikiten
Merge branch 'master' into develop
db79a5b 
* master: (99 commits)
  [Keymap] Added userspace for d4mation. Included their keymap for the Atreus62 (qmk#7483)
  [Keymap] Custom user keymap for Think6.5 with LED range control (qmk#7603)
  [Keymap] CRKBD Custom Keymap - KidBrazil (qmk#7630)
  [Keymap] Add pico 70 keys keymap (qmk#7654)
  Tidy up dztech default keymaps and info.json (qmk#7608)
  Heisenberg handwired keyboard added (qmk#7643)
  [Keyboard] Added Filco Majestouch TKL Pegasus Hoof ISO Layout (qmk#7647)
  Ported J80 to QMK (qmk#7488)
  [Keyboard] Magnavox Videowriter conversion with Pro Micro (qmk#7634)
  [Docs] add japanese translation (basic part) (qmk#7461)
  Tidy up dztech rules.mk
  Relocate RGB keycode processing (qmk#7508)
  Move kwerdenker's personal keymap from RGB (qmk#7645)
  Remove QMK_KEYBOARD_CONFIG_H from boards (qmk#7635)
  Disable usb on slave half to resolve random 'lockup' (qmk#7649)
  [Core] Optimize matrix processing (qmk#7621)
  [Keymap] boy_314's satisfaction75 layout (qmk#7638)
  [Keyboard] XD68 65% ATMega32U4 based (qmk#7395)
  [keyboard] Plain60 cleanups (qmk#7644)
  update default h88 keymap (qmk#7646)
  ...
Shinichi-Ohki added a commit to Shinichi-Ohki/qmk_firmware that referenced this pull request Dec 26, 2019
@Shinichi-Ohki
Merge branch 'master' of https://github.com/qmk/qmk_firmware
01b7405 
* 'master' of https://github.com/qmk/qmk_firmware: (226 commits)
  Make the keyboard beep when Audio is enabled and `\a` is encountered in a sendstring
  Turn off RGB Matrix LEDs when keyboard sleeps (qmk#7713)
  Add backwards compatibility for oled_write_raw_P on ARM
  Update toshi0383 keymap (qmk#7700)
  Completely remove i2c_transmit_receive function (qmk#7686)
  Readded lost pgm_read_word code to encoder array lookups (qmk#7577)
  Add central location for ChibiOS defines (qmk#7542)
  Add TADA68 keymap/rules/config for QMK bootloader (qmk#7679)
  [Docs] fix docs (qmk#7642)
  [Keyboard] Clueboard 60 fix col 11 12 mixup (qmk#7685)
  Missed these LTO blocks
  I corrected my name.
  [Keymap] Added userspace for d4mation. Included their keymap for the Atreus62 (qmk#7483)
  [Keymap] Custom user keymap for Think6.5 with LED range control (qmk#7603)
  [Keymap] CRKBD Custom Keymap - KidBrazil (qmk#7630)
  [Keymap] Add pico 70 keys keymap (qmk#7654)
  Improve docs "Edit Document" footer
  Tidy up dztech config.h
  Tidy up dztech default keymaps and info.json (qmk#7608)
  Heisenberg handwired keyboard added (qmk#7643)
  ...
akrob pushed a commit to akrob/qmk_firmware that referenced this pull request Dec 28, 2019
Merge remote-tracking branch 'upstream/master'
6edd8aa 
* upstream/master: (1080 commits)
  Update toshi0383 keymap (qmk#7700)
  Completely remove i2c_transmit_receive function (qmk#7686)
  Readded lost pgm_read_word code to encoder array lookups (qmk#7577)
  Add central location for ChibiOS defines (qmk#7542)
  Add TADA68 keymap/rules/config for QMK bootloader (qmk#7679)
  [Docs] fix docs (qmk#7642)
  [Keyboard] Clueboard 60 fix col 11 12 mixup (qmk#7685)
  Missed these LTO blocks
  I corrected my name.
  [Keymap] Added userspace for d4mation. Included their keymap for the Atreus62 (qmk#7483)
  [Keymap] Custom user keymap for Think6.5 with LED range control (qmk#7603)
  [Keymap] CRKBD Custom Keymap - KidBrazil (qmk#7630)
  [Keymap] Add pico 70 keys keymap (qmk#7654)
  Improve docs "Edit Document" footer
  Tidy up dztech config.h
  Tidy up dztech default keymaps and info.json (qmk#7608)
  Heisenberg handwired keyboard added (qmk#7643)
  [Keyboard] Added Filco Majestouch TKL Pegasus Hoof ISO Layout (qmk#7647)
  Ported J80 to QMK (qmk#7488)
  [Keyboard] Magnavox Videowriter conversion with Pro Micro (qmk#7634)
  ...
patrl pushed a commit to patrl/qmk_firmware that referenced this pull request Dec 29, 2019
@fauxpark @patrl
Tidy up dztech default keymaps and info.json (qmk#7608)
cf8c9d2
HokieGeek pushed a commit to HokieGeek/qmk_firmware that referenced this pull request Feb 21, 2020
@fauxpark @HokieGeek
Tidy up dztech default keymaps and info.json (qmk#7608)
fe999c5
kylekuj pushed a commit to kylekuj/qmk_firmware that referenced this pull request Apr 21, 2020
@fauxpark @kujawakk
Tidy up dztech default keymaps and info.json (qmk#7608)
3c38eac
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@noroadsleft noroadsleft noroadsleft approved these changes

@drashna drashna drashna approved these changes

Assignees
No one assigned
Labels
enhancement keymap
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fauxpark @noroadsleft @drashna