Skip to content

Commit a7cf08d

Browse files
authored
Merge pull request #294 from JMarkstrom/docs-improvements
Suggested documentation changes to UseFastTrigger
2 parents 90ed378 + 77d3de8 commit a7cf08d

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

Yubico.YubiKey/src/Yubico/YubiKey/Otp/OtpSettings.ExtendedFlags.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,13 @@ public T UseNumericKeypad(bool setting = true) =>
6969
ApplyFlag(Flag.UseNumericKeypad, setting);
7070

7171
/// <summary>
72-
/// Causes the trigger action of the YubiKey button to become faster.
72+
/// Causes the trigger action of the YubiKey button to become faster on early model YubiKeys.
7373
/// </summary>
7474
/// <remarks>
75-
/// This only applies when one configuration is written. If both configurations are active,
76-
/// this setting has no effect.
75+
/// This setting is enabled by default on current generation YubiKeys. As such, the method is
76+
/// maintained for backwards compatibility with older YubiKeys only. Moreover, the fast trigger
77+
/// feature only applies when one slot configuration is written. If both configurations (slot 1 and
78+
/// slot 2) are active / configured, this setting has no effect.
7779
/// </remarks>
7880
public T UseFastTrigger(bool setting = true) =>
7981
ApplyFlag(Flag.FastTrigger, setting);

0 commit comments

Comments
 (0)