Skip to content

Commit b1c8082

Browse files
committed
docs(help): describe jitterPx as a per-axis offset, not a radius
pressJitter multiplies a pattern that includes diagonal offsets, so a press moves up to sqrt(2) x jitterPx. Align the input description, the response schema, and the flag usage description on the per-axis wording. #3788 (comment)
1 parent 138be32 commit b1c8082

3 files changed

Lines changed: 8 additions & 3 deletions

File tree

‎packages/command-registry/src/flag-definitions-action.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ export const ACTION_FLAG_DEFINITIONS: readonly FlagDefinition[] = [
147147
min: 0,
148148
max: 100,
149149
usageLabel: '--jitter-px <n>',
150-
usageDescription: 'Deterministic coordinate jitter radius for press',
150+
usageDescription: 'Deterministic per-axis coordinate jitter in pixels',
151151
projectConfig: true,
152152
recorded: true,
153153
},

‎src/commands/command-input.ts‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -387,7 +387,10 @@ export function repeatedFields() {
387387
count: integerField('Number of press/click repetitions.', { min: 1 }),
388388
intervalMs: integerField('Delay between repeated press/click actions.', { min: 0 }),
389389
holdMs: integerField('Hold duration for each action.', { min: 0 }),
390-
jitterPx: integerField('Deterministic coordinate jitter radius in pixels.', { min: 0 }),
390+
jitterPx: integerField(
391+
'Deterministic per-axis coordinate jitter in pixels (each press offsets x and y by up to this amount).',
392+
{ min: 0 },
393+
),
391394
doubleTap: booleanField('Request a double-tap action.'),
392395
};
393396
}

‎src/commands/interaction/index.ts‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,9 @@ const tapInteractionResponseDataSchema = interactionResponseDataSchema({
229229
count: numberSchema('Number of press/click repetitions.'),
230230
intervalMs: numberSchema('Delay between repeated press/click actions.'),
231231
holdMs: numberSchema('Hold duration for each action.'),
232-
jitterPx: numberSchema('Deterministic coordinate jitter radius in pixels.'),
232+
jitterPx: numberSchema(
233+
'Deterministic per-axis coordinate jitter in pixels (each press offsets x and y by up to this amount).',
234+
),
233235
doubleTap: booleanSchema('Whether the command requested a double-tap action.'),
234236
},
235237
});

0 commit comments

Comments
 (0)