summaryrefslogtreecommitdiff
path: root/src/library/scala/math/BigDecimal.scala
diff options
context:
space:
mode:
authorDominik Gruntz <dominik.gruntz@fhnw.ch>2014-08-06 17:12:20 +0200
committerAntoine Gourlay <antoine@gourlay.fr>2014-08-11 17:56:03 +0200
commit5cb672bdc6e8a662ddc68a07811956e78a134acf (patch)
tree9dc3aa9380b2babcc61d7a43268eb5ccb90f65d2 /src/library/scala/math/BigDecimal.scala
parent2b78c32b42b55b96834df31824fdb081a095cf5f (diff)
downloadscala-5cb672bdc6e8a662ddc68a07811956e78a134acf.tar.gz
scala-5cb672bdc6e8a662ddc68a07811956e78a134acf.tar.bz2
scala-5cb672bdc6e8a662ddc68a07811956e78a134acf.zip
[backport] Fixes cut sentences in the generated scaladocs
This commit changes all first sentences of library functions which contain `i.e.` or `e.g.` and adds a `,` to prevent that the scaladoc summary sentence is cut after this abbreviation. This is possible as pull/3824 fixed how Scaladoc parses the first sentence of a method description into a sumary sentence(now the first sentence has to end with a dot followed by whitespace). Only docs in the core library are changed (src/library/**/*.scala) and only if they occur in the first sentence. Review by @heathermiller (cherry picked from commit 72721ff5dd06dea1235ecb71acae0bd61aee4814)
Diffstat (limited to 'src/library/scala/math/BigDecimal.scala')
-rw-r--r--src/library/scala/math/BigDecimal.scala6
1 files changed, 3 insertions, 3 deletions
diff --git a/src/library/scala/math/BigDecimal.scala b/src/library/scala/math/BigDecimal.scala
index bcbed645a7..5a81710986 100644
--- a/src/library/scala/math/BigDecimal.scala
+++ b/src/library/scala/math/BigDecimal.scala
@@ -617,10 +617,10 @@ extends ScalaNumber with ScalaNumericConversions with Serializable {
*/
def abs: BigDecimal = if (signum < 0) unary_- else this
- /** Returns the sign of this BigDecimal, i.e.
+ /** Returns the sign of this BigDecimal;
* -1 if it is less than 0,
- * +1 if it is greater than 0
- * 0 if it is equal to 0
+ * +1 if it is greater than 0,
+ * 0 if it is equal to 0.
*/
def signum: Int = this.bigDecimal.signum()