plugins/Ranges: Add an explanatory comment above the ranges enum

Signed-off-by: Gergely Nagy <algernon@keyboard.io>
pull/1014/head
Gergely Nagy 4 years ago
parent 9c49d5b2ac
commit 4f9afcfdb9
No known key found for this signature in database
GPG Key ID: AC1E90BAC433F68F

@ -20,6 +20,13 @@
namespace kaleidoscope { namespace kaleidoscope {
namespace ranges { namespace ranges {
// NOTE: We need to keep the ranges stable, and backwards compatible!
//
// When adding, removing, or changing ranges, make sure that existing ranges are
// never accidentally moved. If migrating keycodes that weren't previously using
// the rang system, make sure you keep the old keycodes, even if they short
// before ranges::FIRST, for the sake of remaining backwards compatible with
// existing keymaps.
enum : uint16_t { enum : uint16_t {
// Macro ranges pre-date Kaleidoscope-Ranges, so they're coming before // Macro ranges pre-date Kaleidoscope-Ranges, so they're coming before
// ranges::FIRST, because we want to keep the keycodes backwards compatible. // ranges::FIRST, because we want to keep the keycodes backwards compatible.

Loading…
Cancel
Save