From 36819b65ee04250d877088f871cc90b1ac156038 Mon Sep 17 00:00:00 2001 From: johalloran01 Date: Tue, 4 Jul 2023 12:07:48 -0400 Subject: [PATCH 1/2] added @see for the README documentation --- lib/devise/passkeys/model.rb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lib/devise/passkeys/model.rb b/lib/devise/passkeys/model.rb index 4666925..0f45dd9 100644 --- a/lib/devise/passkeys/model.rb +++ b/lib/devise/passkeys/model.rb @@ -5,9 +5,15 @@ module Models # This is the actual module that gets included in your # model when you include `:passkey_authenticatable` in the # `devise` call (eg: `devise :passkey_authenticatable, ...`). + # + # For more thorough steps on setting up the model please follow link below. + # @see README module PasskeyAuthenticatable # This is a callback that is called right after a successful passkey authentication. # + # *Important*: Must follow the steps in the README documentation to fully set up a model + # and use passkeys. + # # By default, it is a no-op, but you can override it in your model for any custom behavior # (such as notifying the user of a new login). # @param passkey [String] the passkey that was used for authentication From e2a1db19ae3c7a255a0533a70e88551c7a91e0a2 Mon Sep 17 00:00:00 2001 From: Thomas Cannon Date: Fri, 7 Jul 2023 09:29:50 -0400 Subject: [PATCH 2/2] Editing for `Devise::Passkeys::PasskeyAuthenticatable` README references * Wrap in a `file:` tag that YARD can use, add formatting for note about README steps being required. --- lib/devise/passkeys/model.rb | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/lib/devise/passkeys/model.rb b/lib/devise/passkeys/model.rb index 0f45dd9..222b5dd 100644 --- a/lib/devise/passkeys/model.rb +++ b/lib/devise/passkeys/model.rb @@ -6,12 +6,12 @@ module Models # model when you include `:passkey_authenticatable` in the # `devise` call (eg: `devise :passkey_authenticatable, ...`). # - # For more thorough steps on setting up the model please follow link below. - # @see README + # Please consult the {file:README.md#label-Usage} for model installation + # & configuration instructions. module PasskeyAuthenticatable # This is a callback that is called right after a successful passkey authentication. # - # *Important*: Must follow the steps in the README documentation to fully set up a model + # **Important**: You **must** follow the steps in the {file:README.md#label-Usage} to fully set up a model # and use passkeys. # # By default, it is a no-op, but you can override it in your model for any custom behavior