Refine documentation

liufengyun · liufengyun · commit fe38137c99b3 · 2021-03-12T19:46:44.000+01:00
diff --git a/compiler/src/dotty/tools/dotc/transform/init/Effects.scala b/compiler/src/dotty/tools/dotc/transform/init/Effects.scala
@@ -29,11 +29,11 @@ object Effects {
     def toEffs: Effects = Vector(this)
   }
 
-  /** An effect means that a value that's possibly under initialization
+  /** A promotion effect means that a value that's possibly under initialization
    *  is promoted from the initializing world to the fully-initialized world.
    *
    *  Essentially, this effect enforces that the object pointed to by
-   *  `potential` is fully initialized.
+   *  `potential` is transitively initialized.
    *
    *  This effect is trigger in several scenarios:
    *  - a potential is used as arguments to method calls or new-expressions

Original file line number	Diff line number	Diff line change
`@@ -29,11 +29,11 @@ object Effects {`
`29`	`29`	`def toEffs: Effects = Vector(this)`
`30`	`30`	`}`
`31`	`31`
`32`		`- /** An effect means that a value that's possibly under initialization`
	`32`	`+ /** A promotion effect means that a value that's possibly under initialization`
`33`	`33`	`* is promoted from the initializing world to the fully-initialized world.`
`34`	`34`	`*`
`35`	`35`	`* Essentially, this effect enforces that the object pointed to by`
`36`		- * `potential` is fully initialized.
	`36`	+ * `potential` is transitively initialized.
`37`	`37`	`*`
`38`	`38`	`* This effect is trigger in several scenarios:`
`39`	`39`	`* - a potential is used as arguments to method calls or new-expressions`