Skip to content

Commit 6bb829e

Browse files
Replace "Return" with "Returns" in API documentations
The guidelines are explicit about how we should start sentences with "Returns" rather than "Return." So these instances should follow that way. See also the enhancements at rails#50595. Co-authored-by: Jonathan Hefner <[email protected]>
1 parent 3ce8890 commit 6bb829e

File tree

2 files changed

+2
-3
lines changed

2 files changed

+2
-3
lines changed

activerecord/lib/active_record/connection_adapters/abstract/connection_pool.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -475,8 +475,7 @@ def num_waiting_in_queue # :nodoc:
475475
@available.num_waiting
476476
end
477477

478-
# Return connection pool's usage statistic
479-
# Example:
478+
# Returns the connection pool's usage statistic.
480479
#
481480
# ActiveRecord::Base.connection_pool.stat # => { size: 15, connections: 1, busy: 1, dead: 0, idle: 0, waiting: 0, checkout_timeout: 5 }
482481
def stat

activerecord/lib/active_record/connection_handling.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -256,7 +256,7 @@ def connection
256256

257257
attr_writer :connection_specification_name
258258

259-
# Return the connection specification name from the current class or its parent.
259+
# Returns the connection specification name from the current class or its parent.
260260
def connection_specification_name
261261
if @connection_specification_name.nil?
262262
return self == Base ? Base.name : superclass.connection_specification_name

0 commit comments

Comments
 (0)