Browse files

docs, mention that the current inflection rules are frozen. [ci skip]

Closes #13993.
  • Loading branch information...
1 parent 3a428f3 commit 07c70245a128cfe42f134be8759963dc98f1a63e @senny senny committed Feb 10, 2014
Showing with 4 additions and 0 deletions.
  1. +4 −0 activesupport/lib/active_support/inflections.rb
@@ -1,5 +1,9 @@
require 'active_support/inflector/inflections'
+# Define the standard inflection rules. These define a starting point for
+# new projects and are not considered complete. The current set of inflection
+# rules is frozen. This means, we do not change them to become more complete.
+# This is a safety measure to keep existing applications from breaking.
module ActiveSupport
Inflector.inflections(:en) do |inflect|
inflect.plural(/$/, 's')

3 comments on commit 07c7024

senny commented on 07c7024 Feb 10, 2014

/cc @fxn

fxn replied Feb 10, 2014

Good idea. This is a gray area between internal project policies and public interface. But it is good in my view to communicate to end-users they can rely on the current inflection rules.

That is, the target of this comment wouldn't be contributors, but end-users.

Only point is that the comment as is would be part of the documentation of the ActiveSupport module. Could we find a better place for it maybe?

fxn replied Feb 10, 2014

For the archives, we talked with @senny offline. The comment is meant for contributors.

For contributors that spot is the best one in my opinion. The contrib guide explains things at a higher level, this doesn't quite fit there.

Since this is internal documentation, the comment should be hidden from the public API with #--.

Please sign in to comment.