From 4d390e4893a74b78b9eab5b00b38f272a4f4c06d Mon Sep 17 00:00:00 2001
From: dgelessus <dgelessus@users.noreply.github.com>
Date: Mon, 8 Nov 2021 13:58:24 +0100
Subject: [PATCH] Fix outdated help text for :let command
---
notebooks/tests/let.ipynb | 4 ++--
src/main/java/de/prob2/jupyter/commands/LetCommand.java | 2 +-
2 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/notebooks/tests/let.ipynb b/notebooks/tests/let.ipynb
index 968949c..5db7904 100644
--- a/notebooks/tests/let.ipynb
+++ b/notebooks/tests/let.ipynb
@@ -16,7 +16,7 @@
"\n",
"The expression is evaluated once in the current state, and its value is stored. Once set, variables are available in all states. A variable created by `:let` shadows any identifier with the same name from the machine.\n",
"\n",
- "Variables created by `:let` are retained even when a different machine is loaded. To remove a variable, use `:unlet`.\n",
+ "Variables created by `:let` are discarded when a new machine is loaded (or the current machine is reloaded). The `:unlet` command can also be used to manually remove local variables.\n",
"\n",
"**Note:** The values of local variables are currently stored in text form. Values must have a syntactically valid text representation, and large values may cause performance issues."
],
@@ -26,7 +26,7 @@
"\n",
"The expression is evaluated once in the current state, and its value is stored. Once set, variables are available in all states. A variable created by `:let` shadows any identifier with the same name from the machine.\n",
"\n",
- "Variables created by `:let` are retained even when a different machine is loaded. To remove a variable, use `:unlet`.\n",
+ "Variables created by `:let` are discarded when a new machine is loaded (or the current machine is reloaded). The `:unlet` command can also be used to manually remove local variables.\n",
"\n",
"**Note:** The values of local variables are currently stored in text form. Values must have a syntactically valid text representation, and large values may cause performance issues."
]
diff --git a/src/main/java/de/prob2/jupyter/commands/LetCommand.java b/src/main/java/de/prob2/jupyter/commands/LetCommand.java
index 814fb52..0d0a059 100644
--- a/src/main/java/de/prob2/jupyter/commands/LetCommand.java
+++ b/src/main/java/de/prob2/jupyter/commands/LetCommand.java
@@ -61,7 +61,7 @@ public final class LetCommand implements Command {
@Override
public @NotNull String getHelpBody() {
return "The expression is evaluated once in the current state, and its value is stored. Once set, variables are available in all states. A variable created by `:let` shadows any identifier with the same name from the machine.\n\n"
- + "Variables created by `:let` are retained even when a different machine is loaded. To remove a variable, use `:unlet`.\n\n"
+ + "Variables created by `:let` are discarded when a new machine is loaded (or the current machine is reloaded). The `:unlet` command can also be used to manually remove local variables.\n\n"
+ "**Note:** The values of local variables are currently stored in text form. Values must have a syntactically valid text representation, and large values may cause performance issues.";
}
--
GitLab