Skip to content

Commit be61803

Browse files
Reword doc for Encryptor.new :compressor option [ci-skip]
1 parent 63cb083 commit be61803

File tree

1 file changed

+2
-4
lines changed

1 file changed

+2
-4
lines changed

activerecord/lib/active_record/encryption/encryptor.rb

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,8 @@ class Encryptor
1818
#
1919
# * <tt>:compress</tt> - Boolean indicating whether records should be compressed before encryption.
2020
# Defaults to +true+.
21-
# * <tt>:compressor</tt> - The compressor to use.
22-
# 1. If compressor is provided, it will be used.
23-
# 2. If not, it will use +ActiveRecord::Encryption.config.compressor+, which default value is +Zlib+.
24-
# If you want to use a custom compressor, it must respond to +deflate+ and +inflate+.
21+
# * <tt>:compressor</tt> - The compressor to use. It must respond to +deflate+ and +inflate+.
22+
# If not provided, will default to +ActiveRecord::Encryption.config.compressor+, which itself defaults to +Zlib+.
2523
def initialize(compress: true, compressor: nil)
2624
@compress = compress
2725
@compressor = compressor || ActiveRecord::Encryption.config.compressor

0 commit comments

Comments
 (0)