Skip to content

Commit

Permalink
Merge pull request #44693 from ghousemohamed/fix-docs-related-gem-ver…
Browse files Browse the repository at this point in the history
…sions

Fix `#version` method docs and some typos [ci-skip]
  • Loading branch information
rafaelfranca committed Mar 15, 2022
1 parent d364b5f commit 2cf820d
Show file tree
Hide file tree
Showing 26 changed files with 26 additions and 26 deletions.
2 changes: 1 addition & 1 deletion actioncable/lib/action_cable/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActionCable
# Returns the version of the currently loaded Action Cable as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Action Cable as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion actioncable/lib/action_cable/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActionCable
# Returns the version of the currently loaded Action Cable as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Action Cable as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion actionmailbox/lib/action_mailbox/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActionMailbox
# Returns the currently-loaded version of Action Mailbox as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Action Mailbox as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion actionmailbox/lib/action_mailbox/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActionMailbox
# Returns the currently-loaded version of Action Mailbox as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Action Mailbox as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion actionmailer/lib/action_mailer/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActionMailer
# Returns the version of the currently loaded Action Mailer as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Action Mailer as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion actionmailer/lib/action_mailer/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActionMailer
# Returns the version of the currently loaded Action Mailer as a
# Returns the currently loaded version of Action Mailer as a
# <tt>Gem::Version</tt>.
def self.version
gem_version
Expand Down
2 changes: 1 addition & 1 deletion actionpack/lib/action_pack/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActionPack
# Returns the version of the currently loaded Action Pack as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Action Pack as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion actionpack/lib/action_pack/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActionPack
# Returns the version of the currently loaded ActionPack as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Action Pack as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion actiontext/lib/action_text/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActionText
# Returns the currently-loaded version of Action Text as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Action Text as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion actiontext/lib/action_text/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActionText
# Returns the currently-loaded version of Action Text as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Action Text as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActionView
# Returns the version of the currently loaded Action View as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Action View as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion actionview/lib/action_view/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActionView
# Returns the version of the currently loaded ActionView as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Action View as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveJob
# Returns the version of the currently loaded Active Job as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Active Job as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion activejob/lib/active_job/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActiveJob
# Returns the version of the currently loaded Active Job as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Active Job as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveModel
# Returns the version of the currently loaded \Active \Model as a <tt>Gem::Version</tt>
# Returns the currently loaded version of \Active \Model as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion activemodel/lib/active_model/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActiveModel
# Returns the version of the currently loaded \Active \Model as a <tt>Gem::Version</tt>
# Returns the currently loaded version of \Active \Model as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion activerecord/lib/active_record/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveRecord
# Returns the version of the currently loaded Active Record as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Active Record as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion activerecord/lib/active_record/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActiveRecord
# Returns the version of the currently loaded ActiveRecord as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Active Record as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion activestorage/lib/active_storage/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveStorage
# Returns the version of the currently loaded Active Storage as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Active Storage as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion activestorage/lib/active_storage/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActiveStorage
# Returns the version of the currently loaded ActiveStorage as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Active Storage as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion activesupport/lib/active_support/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module ActiveSupport
# Returns the version of the currently loaded Active Support as a <tt>Gem::Version</tt>.
# Returns the currently loaded version of Active Support as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion activesupport/lib/active_support/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module ActiveSupport
# Returns the version of the currently loaded ActiveSupport as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Active Support as a <tt>Gem::Version</tt>.
def self.version
gem_version
end
Expand Down
2 changes: 1 addition & 1 deletion guides/source/2_3_release_notes.md
Expand Up @@ -266,7 +266,7 @@ end

### More Efficient Routing

There are a couple of significant routing changes in Rails 2.3. The `formatted_` route helpers are gone, in favor just passing in `:format` as an option. This cuts down the route generation process by 50% for any resource - and can save a substantial amount of memory (up to 100MB on large applications). If your code uses the `formatted_` helpers, it will still work for the time being - but that behavior is deprecated and your application will be more efficient if you rewrite those routes using the new standard. Another big change is that Rails now supports multiple routing files, not just `routes.rb`. You can use `RouteSet#add_configuration_file` to bring in more routes at any time - without clearing the currently-loaded routes. While this change is most useful for Engines, you can use it in any application that needs to load routes in batches.
There are a couple of significant routing changes in Rails 2.3. The `formatted_` route helpers are gone, in favor just passing in `:format` as an option. This cuts down the route generation process by 50% for any resource - and can save a substantial amount of memory (up to 100MB on large applications). If your code uses the `formatted_` helpers, it will still work for the time being - but that behavior is deprecated and your application will be more efficient if you rewrite those routes using the new standard. Another big change is that Rails now supports multiple routing files, not just `routes.rb`. You can use `RouteSet#add_configuration_file` to bring in more routes at any time - without clearing the currently loaded routes. While this change is most useful for Engines, you can use it in any application that needs to load routes in batches.

* Lead Contributors: [Aaron Batalion](http://blog.hungrymachine.com/)

Expand Down
2 changes: 1 addition & 1 deletion railties/lib/rails/gem_version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module Rails
# Returns the version of the currently loaded Rails as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Rails as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion railties/lib/rails/version.rb
Expand Up @@ -3,7 +3,7 @@
require_relative "gem_version"

module Rails
# Returns the version of the currently loaded Rails as a string.
# Returns the currently loaded version of Rails as a string.
def self.version
VERSION::STRING
end
Expand Down
2 changes: 1 addition & 1 deletion version.rb
@@ -1,7 +1,7 @@
# frozen_string_literal: true

module Rails
# Returns the version of the currently loaded Rails as a <tt>Gem::Version</tt>
# Returns the currently loaded version of Rails as a <tt>Gem::Version</tt>.
def self.gem_version
Gem::Version.new VERSION::STRING
end
Expand Down

0 comments on commit 2cf820d

Please sign in to comment.