minor: docs for deprecated class

2010-01-25 13:40:26 -05:00 · 2010-01-25 13:40:26 -05:00 · 10dc5daed1
commit 10dc5daed1
parent 297e5f81c4
1 changed files with 2 additions and 0 deletions
--- a/lib/mongo/types/regexp_of_holding.rb
+++ b/lib/mongo/types/regexp_of_holding.rb
@ -24,6 +24,8 @@ module Mongo
  # Note that you do not have to use this class at all if you wish to
  # store regular expressions in Mongo. The Mongo and Ruby regex option
  # flags are the same. Storing regexes is discouraged, in any case.
+  # 
+  # @deprecated
  class RegexpOfHolding < Regexp

    attr_accessor :extra_options_str