Update stripPrefix/StringLike docs to talk about no op case

Max Bileschi · adriaanm · commit efbef1e02c06 · 2014-10-07T10:39:31.000+02:00
Incorporate review comments by Som Snytt.
diff --git a/src/library/scala/collection/immutable/StringLike.scala b/src/library/scala/collection/immutable/StringLike.scala
@@ -135,23 +135,29 @@ self =>
   def linesIterator: Iterator[String] =
     linesWithSeparators map (line => new WrappedString(line).stripLineEnd)
 
-  /** Returns this string with first character converted to upper case */
+  /** Returns this string with first character converted to upper case.
+   * If the first character of the string is capitalized, it is returned unchanged.
+   */
   def capitalize: String =
     if (toString == null) null
     else if (toString.length == 0) ""
+    else if (toString.charAt(0).isUpper) toString
     else {
       val chars = toString.toCharArray
       chars(0) = chars(0).toUpper
       new String(chars)
     }
 
-  /** Returns this string with the given `prefix` stripped. */
+  /** Returns this string with the given `prefix` stripped. If this string does not
+   *  start with `prefix`, it is returned unchanged.
+   */
   def stripPrefix(prefix: String) =
     if (toString.startsWith(prefix)) toString.substring(prefix.length)
     else toString
 
   /** Returns this string with the given `suffix` stripped. If this string does not
-    * end with `suffix`, it is returned unchanged. */
+   *  end with `suffix`, it is returned unchanged.
+   */
   def stripSuffix(suffix: String) =
     if (toString.endsWith(suffix)) toString.substring(0, toString.length() - suffix.length)
     else toString
