[DOC] Small adjustment for String method docs

* Hide freeze method (no useful docs, same as Object#freeze)
* Add dedup to call-seq of str_uminus

1 files changed, 13 insertions, 1 deletions

diff --git a/string.c b/string.c
index 38a26022f9..113265a8f9 100644
--- a/string.c
+++ b/string.c
@@ -2950,6 +2950,7 @@ str_substr(VALUE str, long beg, long len, int empty)
     return str2;
 }
 
+/* :nodoc: */
 VALUE
 rb_str_freeze(VALUE str)
 {
@@ -2981,13 +2982,24 @@ str_uplus(VALUE str)
 /*
  * call-seq:
  *   -string -> frozen_string
+ *   dedup -> frozen_string
  *
  * Returns a frozen, possibly pre-existing copy of the string.
  *
  * The returned \String will be deduplicated as long as it does not have
  * any instance variables set on it and is not a String subclass.
  *
- * String#dedup is an alias for String#-@.
+ * Note that <tt>-string</tt> variant is more convenient for defining
+ * constants:
+ *
+ *    FILENAME = -'config/database.yml'
+ *
+ * while +dedup+ is better suitable for using the method in chains
+ * of calculations:
+ *
+ *
+ *    @url_list.concat(urls.map(&:dedup))
+ *
  */
 static VALUE
 str_uminus(VALUE str)