Connecting documentation of setLiteralSource with PatchedModuleValues

enso-org · Jun 16, 2022 · 574625c · 574625c
1 parent 9240bda
commit 574625c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/engine/runtime/src/main/java/org/enso/interpreter/runtime/Module.java b/engine/runtime/src/main/java/org/enso/interpreter/runtime/Module.java
@@ -205,6 +205,7 @@ public void setLiteralSource(String source) {
    *
    * @param source the module source.
    * @param update suggested small change in a single literal or {@code null}
+   * @see PatchedModuleValues
    */
   public void setLiteralSource(Rope source, SimpleUpdate update) {
     if (this.scope != null && update != null) {

diff --git a/engine/runtime/src/main/java/org/enso/interpreter/runtime/PatchedModuleValues.java b/engine/runtime/src/main/java/org/enso/interpreter/runtime/PatchedModuleValues.java
@@ -50,7 +50,8 @@ synchronized void dispose() {
    * Edits are always deleting few characters and inserting another few characters
    * at a given location. The idea here is to use {@code SortedMap} to keep
    * information about "deltas" at each offset of modification. Whenever new
-   *
+   * edit is made, the delta at its offset is recorded and all deltas after
+   * the offset adjusted as they shift too.
    *
    * @param instr instrumented to attach itself as a ultimate source of values
    *    for {@link Patchable.Tag} nodes