Skip to content

Commit 4726b1a

Browse files
Ensure on_rotation appears in RDoc [ci-skip]
When a `:method:` doc is immediately followed by the `private` keyword, RDoc will hide that doc as if it were a private method. To ensure that `ActiveSupport::MessageEncryptors#on_rotation` and `ActiveSupport::MessageVerifiers#on_rotation` both appear in the rendered docs, this commit adds a delimiter comment before each `private` keyword.
1 parent c8b3642 commit 4726b1a

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

activesupport/lib/active_support/message_encryptors.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -130,6 +130,7 @@ class MessageEncryptors < Messages::RotationCoordinator
130130
# indicate whether old option sets are still in use or can be removed from
131131
# rotation.
132132

133+
##
133134
private
134135
def build(salt, secret_generator:, secret_generator_options:, **options)
135136
secret_length = MessageEncryptor.key_len(*options[:cipher])

activesupport/lib/active_support/message_verifiers.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,7 @@ class MessageVerifiers < Messages::RotationCoordinator
126126
# indicate whether old option sets are still in use or can be removed from
127127
# rotation.
128128

129+
##
129130
private
130131
def build(salt, secret_generator:, secret_generator_options:, **options)
131132
MessageVerifier.new(secret_generator.call(salt, **secret_generator_options), **options)

0 commit comments

Comments
 (0)