qmk / qmk_firmware

Open-source keyboard firmware for Atmel AVR and Arm USB families
https://qmk.fm
GNU General Public License v2.0
18.29k stars 39.42k forks source link

doc mistake #16700

Closed tara81 closed 2 years ago

tara81 commented 2 years ago

https://docs.qmk.fm/#/feature_stenography?id=plover-with-steno-protocol

void eeconfig_init_user() { steno_set_mode(STENO_MODE_GEMINI); // or STENO_MODE_BOLT }

should be

void matrix_init_user() { steno_set_mode(STENO_MODE_GEMINI); }

MacroLens commented 2 years ago

This issue may be incorrect, as I don't think the comment is incorrect. It's well documented that you can set the stenography mode to either Gemini or Bolt. What exactly is the issue? If there is an actual issue with STENO_MODE_BOLT can you detail it?

tara81 commented 2 years ago

When I set steno to Gemini , it defaults to bolt. Like the documentation is wrong?

tzarc commented 2 years ago

It's not wrong, it sets it once and only once, when the EEPROM is reset. That is the purpose of the eeconfig_xxxxxxx class of function. After that, whatever is selected by the user is retained as the default.

At some point, STENO_MODE_BOLT must have been stored in EEPROM. The next powerup, it reloads STENO_MODE_BOLT.

precondition commented 2 years ago

When I set steno to Gemini , it defaults to bolt. Like the documentation is wrong?

@tara81 Some keyboards don't support EEPROM, in which case your choice isn't memorised and you'll need to press QK_STENO_GEMINI every time you reboot your keyboard in order to select GeminiPR (since the default mode is TX Bolt). That limitation only affects a few QMK keyboards (not sure of the exact proportion) but if you're in this situation, you may be interested in my steno PR which doesn't rely on EEPROM and lets you compile only your desired steno protocol.

github-actions[bot] commented 2 years ago

This issue has been automatically marked as stale because it has not had activity in the last 90 days. It will be closed in the next 30 days unless it is tagged properly or other activity occurs. For maintainers: Please label with bug, in progress, on hold, discussion or to do to prevent the issue from being re-flagged.

github-actions[bot] commented 2 years ago

This issue has been automatically closed because it has not had activity in the last 30 days. If this issue is still valid, re-open the issue and let us know. // [stale-action-closed]