summaryrefslogtreecommitdiffstats
path: root/docs/feature_wpm.md
diff options
context:
space:
mode:
authorvectorstorm <github@gridbug.org>2021-12-27 11:52:56 +1100
committerGitHub <noreply@github.com>2021-12-27 11:52:56 +1100
commit0391801267799dfe233cd0962357a0bf332c3908 (patch)
tree4469e8cf552d58730642e795af506eb0d4b1f7d5 /docs/feature_wpm.md
parent6e40dfa0220e68a6628d9e7d18788df6bcae5473 (diff)
Fixes potential wpm sampling overflow, along with code comment fixes (#15277)
Co-authored-by: Trevor Powell <trevor@vectorstorm.com.au>
Diffstat (limited to 'docs/feature_wpm.md')
-rw-r--r--docs/feature_wpm.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/docs/feature_wpm.md b/docs/feature_wpm.md
index 87145c97e3..9f98ef8336 100644
--- a/docs/feature_wpm.md
+++ b/docs/feature_wpm.md
@@ -16,7 +16,7 @@ For split keyboards using soft serial, the computed WPM score will be available
| `WPM_ALLOW_COUNT_REGRESSION` | _Not defined_ | If defined allows the WPM to be decreased when hitting Delete or Backspace |
| `WPM_UNFILTERED` | _Not defined_ | If undefined (the default), WPM values will be smoothed to avoid sudden changes in value |
| `WPM_SAMPLE_SECONDS` | `5` | This defines how many seconds of typing to average, when calculating WPM |
-| `WPM_SAMPLE_PERIODS` | `50` | This defines how many sampling periods to use when calculating WPM |
+| `WPM_SAMPLE_PERIODS` | `25` | This defines how many sampling periods to use when calculating WPM |
| `WPM_LAUNCH_CONTROL` | _Not defined_ | If defined, WPM values will be calculated using partial buffers when typing begins |
'WPM_UNFILTERED' is potentially useful if you're filtering data in some other way (and also because it reduces the code required for the WPM feature), or if reducing measurement latency to a minimum is important for you.