[IFT] Text fixes
authorAlexey Merkulov <alexey.merkulov@jetbrains.com>
Mon, 27 Jul 2020 12:17:13 +0000 (15:17 +0300)
committerintellij-monorepo-bot <intellij-monorepo-bot-no-reply@jetbrains.com>
Mon, 27 Jul 2020 18:22:38 +0000 (18:22 +0000)
GitOrigin-RevId: c15c2ce19a0b2417d2dd8d7f73d0df6859ed786a

16 files changed:
ide-features-trainer/src/training/learn/lesson/general/CollapseLesson.kt
ide-features-trainer/src/training/learn/lesson/general/DuplicateLesson.kt
ide-features-trainer/src/training/learn/lesson/general/GotoActionLesson.kt
ide-features-trainer/src/training/learn/lesson/general/MoveLesson.kt
ide-features-trainer/src/training/learn/lesson/general/SelectLesson.kt
ide-features-trainer/src/training/learn/lesson/general/SurroundAndUnwrapLesson.kt
ide-features-trainer/src/training/learn/lesson/general/completion/BasicCompletionLessonBase.kt
ide-features-trainer/src/training/learn/lesson/general/navigation/DeclarationAndUsagesLesson.kt
ide-features-trainer/src/training/learn/lesson/general/navigation/FileStructureLesson.kt
ide-features-trainer/src/training/learn/lesson/general/refactorings/ExtractMethodCocktailSortLesson.kt
ide-features-trainer/src/training/learn/lesson/general/refactorings/ExtractVariableFromBubleLesson.kt
ide-features-trainer/src/training/learn/lesson/python/completion/PythonTabCompletionLesson.kt
ide-features-trainer/src/training/learn/lesson/python/refactorings/PythonInPlaceRefactoringLesson.kt
ide-features-trainer/src/training/learn/lesson/python/refactorings/PythonQuickFixesRefactoringLesson.kt
ide-features-trainer/src/training/learn/lesson/python/refactorings/PythonRefactorMenuLesson.kt
ide-features-trainer/src/training/learn/lesson/python/refactorings/PythonRenameLesson.kt

index ed458c77abfd73fa9e78c7f4492a3073c5de8a39..31f24c0e3a477442783ee47ff9174c5d639d336d 100644 (file)
@@ -13,7 +13,7 @@ class CollapseLesson(module: Module, lang: String, private val sample: LessonSam
       prepareSample(sample)
 
       actionTask("CollapseRegion") {
-        "Sometimes you need to collapse a piece of code for better readability. Try collapsing code with ${action(it)}."
+        "Sometimes you need to collapse a piece of code for better readability. Try to collapse a code fragment with ${action(it)}."
       }
       actionTask("ExpandRegion") {
         "To expand a code region, hit ${action(it)}."
index cd7a1cd55e6bb01075275af4edd7d3a146b5f98a..76015bbc71de86f284e624af77eacfb9ae83fc09 100644 (file)
@@ -15,7 +15,7 @@ class DuplicateLesson(module: Module, lang: String, private val sample: LessonSa
       actionTask("EditorDuplicate") { "Duplicate any line with ${action(it)}." }
 
       task("EditorDuplicate") {
-        text("You can do the same thing with multiple lines, too. Simply select two or more lines and duplicate them with ${action(it)}.")
+        text("You can do the same action with multiple lines, too. Simply select two or more lines and duplicate them with ${action(it)}.")
         trigger(it, {
           val selection = editor.selectionModel
           val start = selection.selectionStartPosition?.line ?: 0
@@ -25,7 +25,7 @@ class DuplicateLesson(module: Module, lang: String, private val sample: LessonSa
         test { actions("EditorUp", "EditorLineStart", "EditorDownWithSelection", "EditorDownWithSelection", it) }
       }
       actionTask("EditorDeleteLine") {
-        "To delete current line you can use action ${action(it)}."
+        "To delete the current line you can use action ${action(it)}."
       }
     }
 }
\ No newline at end of file
index 9af8097a1b4e202e433290260d76b7318a9c3d12..a8c6a2b317bc95f4e4aa060f5912c54b8ea238f4 100644 (file)
@@ -34,7 +34,7 @@ class GotoActionLesson(module: Module, lang: String, private val sample: LessonS
                         "refer to <a href=\"$FIND_ACTION_WORKAROUND\">this article</a>." else ""
       }
       actionTask("About") {
-        "Let's say you want to read about the IDE, type <strong>about</strong> and press ${action("EditorEnter")}."
+        "Let's say you want to learn about the IDE, type <strong>about</strong> and press ${action("EditorEnter")}."
       }
       task {
         text("Hit ${action("EditorEscape")} to return to the editor.")
index 4540f4cce40e81c73ebd362d1e98f971d9f1134c..9bb2e205030424e5eaa76347c39451a9d1b1181c 100644 (file)
@@ -14,15 +14,15 @@ class MoveLesson(module: Module, lang: String, private val sample: LessonSample)
       prepareSample(sample)
 
       actionTask("MoveLineDown") {
-        "Rearranging lines usually takes two actions: cut and paste. In this IDE, you can do it with just one: " +
-        "pressing ${action(it)} will pull down the current line."
+        "Rearranging lines usually takes two actions: cut and paste. In this IDE, you can do it with just one. " +
+        "Press ${action(it)} to pull down the current line."
       }
       actionTask("MoveLineUp") {
         "Similarly, to pull a line up, use ${action(it)}."
       }
       if (lang == JavaLangSupport.lang) caret(9, 5)
       task("MoveStatementUp") {
-        text("Now try moving the whole method up with ${action(it)}.")
+        text("Now try to move the whole method up with ${action(it)}.")
         trigger(it, { editor.document.text }, { before, now ->
           checkSwapMoreThan2Lines(before, now)
         })
index 4c855d7dd27138e8efac5fdf7f5eb1148900a73e..b1413373a73d6b581293e71a1220567a181a3019 100644 (file)
@@ -19,7 +19,7 @@ class SelectLesson(module: Module, lang: String, private val sample: LessonSampl
         "Press ${action(it)} to extend the selection to the next code block."
       }
       task("EditorSelectWord") {
-        text("Try increasing your selection with ${action(it)} until your whole file is selected.")
+        text("Try to increase your selection with ${action(it)} until your whole file is selected.")
         trigger(it) {
           editor.selectionModel.selectionStart == 0 && editor.document.textLength == editor.selectionModel.selectionEnd
         }
index 0d18d698624d412a425a660bf18b6264ca0805ed..40f4fa6af425a43018620a61dc14bf5c256954d6 100644 (file)
@@ -28,7 +28,7 @@ abstract class SurroundAndUnwrapLesson(module: Module, lang: String) :
           editor.caretModel.currentCaret.selectionStart != previous.sample.selection?.first ||
           editor.caretModel.currentCaret.selectionEnd != previous.sample.selection?.second
         }
-        text("Press ${action(it)} to surround selected code with some template code.")
+        text("Press ${action(it)} to surround the selected code fragment with some template code.")
         triggerByListItemAndHighlight { item ->
           surroundItems.all { need -> wordIsPresent(item.toString(), need) }
         }
@@ -58,7 +58,7 @@ abstract class SurroundAndUnwrapLesson(module: Module, lang: String) :
         proposeIfModified {
           editor.caretModel.currentCaret.logicalPosition.line != previous.position.line
         }
-        text("Lets return to the initial file with unwrapping action by ${action(it)}.")
+        text("Let's return to the initial file with unwrapping action by ${action(it)}.")
         triggerByListItemAndHighlight { item ->
           wordIsPresent(item.toString(), surroundItems[0])
         }
index 816ef549dc0f229f3ccd3f68390307fb9bdb08c7..9a3180e688408e8f1d8f0aa687b61ea54374406a 100644 (file)
@@ -48,7 +48,7 @@ abstract class BasicCompletionLessonBase(module: Module, lang: String) : KLesson
         }
       }
       task {
-        text("Continue typing <code>$item1Completion</code> unless it become the first item.")
+        text("Continue typing <code>$item1Completion</code> unless it becomes the first item.")
         stateCheck {
           (previous.ui as? JList<*>)?.let {
             isTheFirstVariant(it)
index c71b5b923dca30c32784727a6f43d2608ac512f1..550f451f62c68f1f876777b6e09f5337abcc5330 100644 (file)
@@ -34,7 +34,7 @@ abstract class DeclarationAndUsagesLesson(module: Module, lang: String) : KLesso
       }
 
       task("GotoDeclaration") {
-        text("Now the caret is on the attribute accessor declaration. " +
+        text("Now the caret is at the attribute accessor declaration. " +
              "Use the same shortcut ${action(it)} to see all of its usages, then select one of them.")
         trigger(it, { state() }) l@{ before, now ->
           if (before == null || now == null) {
index bdfafb1d687167d4573e8599ddba616bc0be0d41..70bc1982102db8ee9da33ba400536539b9757850 100644 (file)
@@ -37,7 +37,7 @@ abstract class FileStructureLesson(module: Module, lang: String) : KLesson("File
         }
       }
       task {
-        text("Only the one item remains. Now press <strong>Enter</strong> to jump to the selected item.")
+        text("Only one item remains. Now press <strong>Enter</strong> to jump to the selected item.")
         stateCheck { focusOwner is EditorComponentImpl }
         test { GuiTestUtil.shortcut(Key.ENTER) }
       }
index 4b16d80200ad187ee72b41426fff1557316e47f8..ae0d5eda6816ae49d6214f11af27701835a14c01 100644 (file)
@@ -39,7 +39,7 @@ class ExtractMethodCocktailSortLesson(module: Module, lang: String, private val
       }
 
       task {
-        text("Cocktail Sort has 2 swap places. The first fragment has just been extracted. Click <strong>Yes</strong> to extract both of them.")
+        text("Cocktail Sort has two swap places. The first fragment has just been extracted. Click <strong>Yes</strong> to extract both of them.")
 
         // Wait until the third dialog
         triggerByUiComponentAndHighlight(highlightBorder = false, highlightInside = false) { dialog : JDialog ->
@@ -55,7 +55,7 @@ class ExtractMethodCocktailSortLesson(module: Module, lang: String, private val
         }
       }
       task {
-        text("Now you can confirm or reject replacement of the second fragment.")
+        text("Now you can confirm or reject the replacement of the second fragment.")
 
         stateCheck {
           previous.ui?.isShowing?.not() ?: true
index c8ff359492ffd1d77cfa14e041c077b4d23baaa4..fb5993d1d117735fa9748b295eb5114500b3abe6 100644 (file)
@@ -21,7 +21,7 @@ class ExtractVariableFromBubbleLesson(module: Module, lang: String, private val
 
       task {
         text("This code block contains 3 occurrences of the selected expression. " +
-             "Choose the second item in the list to replace both of them.")
+             "Choose the second item on the list to replace all of them.")
 
         stateCheck {
           editor.document.text.split("i + 1").size == 2
index d0daee9dbd59115801a86a9434da82fdfa04ddcd..12631f2af621517e88a39d2afdd5d44986203bb7 100644 (file)
@@ -32,7 +32,7 @@ class PythonTabCompletionLesson(module: Module) : KLesson("Tab completion", modu
       return {
         prepareSample(sample)
         task("CodeCompletion") {
-          text("Suppose you want to replace ${code("current")} by ${code("total")}. Invoke completion by pressing ${action(it)}.")
+          text("Suppose you want to replace ${code("current")} with ${code("total")}. Invoke completion by pressing ${action(it)}.")
           triggerByListItemAndHighlight(checkList = { ui -> isTotalItem(ui) })
           proposeRestoreMe()
           test { actions(it) }
@@ -56,7 +56,7 @@ class PythonTabCompletionLesson(module: Module) : KLesson("Tab completion", modu
         task {
           val result = LessonUtil.insertIntoSample(template, "total")
           text("If you press ${action("EditorEnter")} you will insert ${code("total")} before ${code("current")}. " +
-               "Instead press ${action("EditorTab")} to replace ${code("current")} by ${code("total")}")
+               "Instead press ${action("EditorTab")} to replace ${code("current")} with ${code("total")}")
 
           trigger("EditorChooseLookupItemReplace") {
             editor.document.text == result
index 2e76d95b2a8c7e12ff2cc409260904043ae42fc7..1fd937bd042e89749109a7debb8eedced68dd1e9 100644 (file)
@@ -9,7 +9,7 @@ import training.learn.lesson.kimpl.*
 import javax.swing.JLabel
 import javax.swing.JPanel
 
-class PythonInPlaceRefactoringLesson(module: Module) : KLesson("In place refactoring", module, "Python") {
+class PythonInPlaceRefactoringLesson(module: Module) : KLesson("refactoring.in.place", "In-place refactoring", module, "Python") {
   private val template = """
     def fibonacci(stop):
         first = 0
@@ -29,7 +29,7 @@ class PythonInPlaceRefactoringLesson(module: Module) : KLesson("In place refacto
   override val lessonContent: LessonContext.() -> Unit = {
     prepareSample(sample)
     task {
-      text("Let's consider an alternative approach to perform refactorings. Suppose we want to rename local variable ${code(variableName)} " +
+      text("Let's consider an alternative approach to performing refactorings. Suppose we want to rename local variable ${code(variableName)} " +
            "to ${code("second")}. Just start typing the new name.")
       stateCheck {
         editor.document.text != sample.text
@@ -39,7 +39,7 @@ class PythonInPlaceRefactoringLesson(module: Module) : KLesson("In place refacto
 
     task("ShowIntentionActions") {
       text("IDE is guessing that you are going to rename the variable. " +
-           "You can notice it by the icon ${icon(AllIcons.Gutter.SuggestedRefactoringBulb)} at the left editor gutter. " +
+           "You can notice it by the icon ${icon(AllIcons.Gutter.SuggestedRefactoringBulb)} in the left editor gutter. " +
            "Invoke intentions by ${action(it)} when you finish to type the new name.")
       triggerByListItemAndHighlight(highlightBorder = true, highlightInside = false) { ui -> // no highlighting
         ui.toString().contains("Rename usages")
@@ -72,7 +72,7 @@ class PythonInPlaceRefactoringLesson(module: Module) : KLesson("In place refacto
 
     task {
       text("Let's add an argument to this method. We place the editor caret just after the first parameter. " +
-           "Now type comma and parameter name: ${code(", start")} .")
+           "Now type comma and parameter's name: ${code(", start")} .")
       stateCheck {
         val text = editor.document.text
         val parameter = text.substring(secondSample.startOffset, text.indexOf(')'))
@@ -85,7 +85,7 @@ class PythonInPlaceRefactoringLesson(module: Module) : KLesson("In place refacto
     task("ShowIntentionActions") {
       text("IDE is guessing that you are going to change the method signature. " +
            "You can notice it by the same icon ${icon(AllIcons.Gutter.SuggestedRefactoringBulb)} at the left editor gutter. " +
-           "Invoke intentions by ${action(it)} when you finish to type the new parameter.")
+           "Invoke intentions by ${action(it)} when you finish typing the new parameter.")
       triggerByListItemAndHighlight(highlightBorder = true, highlightInside = false) { item ->
         item.toString().contains("Update usages to")
       }
@@ -116,7 +116,7 @@ class PythonInPlaceRefactoringLesson(module: Module) : KLesson("In place refacto
       before {
         beforeSecondRefactoring = editor.document.text
       }
-      text("Now you need to type the value which will be inserted as an argument to the each call. " +
+      text("Now you need to type the value which will be inserted as an argument into the each call. " +
            "You can choose ${code("0")} for this sample. Then press ${action("EditorEnter")} to continue.")
       stateCheck {
         editor.document.text != beforeSecondRefactoring && Thread.currentThread().stackTrace.any {
index 06d23fad37e79a41670f471088b9ec14f520179b..898c8876ddf534ad7e2ea735bac681cec2b99a29 100644 (file)
@@ -35,20 +35,20 @@ class PythonQuickFixesRefactoringLesson(module: Module) : KLesson("quick-fix-ref
     }
 
     task {
-      text("Wait a little bit for completion list...")
+      text("Wait a little bit for the completion list...")
       triggerByListItemAndHighlight(highlightBorder = false, highlightInside = false) { item ->
         item.toString().contains("string=y")
       }
     }
 
     task {
-      text("But we do not need completion now. Close it (${action("EditorEscape")}).")
+      text("For now, we don't want to apply any completion. Close the list (${action("EditorEscape")}).")
       stateCheck { previous.ui?.isShowing != true }
       test { GuiTestUtil.shortcut(Key.ESCAPE) }
     }
 
     task("ShowIntentionActions") {
-      text("As you may notice IDE is showing you a warning here. Let's invoke intentions by ${action(it)}.")
+      text("As you may notice, IDE is showing you a warning here. Let's invoke intentions by ${action(it)}.")
       triggerByListItemAndHighlight(highlightBorder = true, highlightInside = false) { item ->
         item.toString().contains("Change signature of")
       }
@@ -75,7 +75,7 @@ class PythonQuickFixesRefactoringLesson(module: Module) : KLesson("quick-fix-ref
     }
     task {
       text("Let's set the default value for the new parameter. Click at the new parameter line. " +
-           "Alternatively you can set focus to the parameter without mouse by ${action("EditorTab")} and then ${action("EditorEnter")}.")
+           "Alternatively, you can set focus to the parameter without mouse by ${action("EditorTab")} and then ${action("EditorEnter")}.")
 
       triggerByUiComponentAndHighlight(highlightBorder = false, highlightInside = false) { label: JLabel ->
         label.text == "Default value:"
@@ -90,9 +90,9 @@ class PythonQuickFixesRefactoringLesson(module: Module) : KLesson("quick-fix-ref
       before {
         beforeRefactoring = editor.document.text
       }
-      text("You may navigate through the fields (and the checkbox) by ${action("EditorTab")}. " +
-           "By the checkbox you can choose whether IDE will inline the default values to the other callers or set it as default value for the new parameter. " +
-           "The Signature Preview will help to understand the difference. Now set the default value as 0 and press <raw_action>Ctrl + Enter</raw_action> " +
+      text("You may navigate through the fields (and the checkbox) by using ${action("EditorTab")}. " +
+           "With the checkbox you can let IDE inline the default value to the other callers or set it as the default value for the new parameter. " +
+           "The Signature Preview will help understand the difference. Now set the default value as 0 and press <raw_action>Ctrl + Enter</raw_action> " +
            "(or click <strong>Do Refactor</strong>) to finish the refactoring.")
 
       stateCheck {
index a55e5b4db43ec09a2890091a74dddf58be8f702d..48be0680e01166f93503fdb7b7c57381b5594da2 100644 (file)
@@ -28,7 +28,7 @@ class PythonRefactorMenuLesson(module: Module) : KLesson("Refactoring menu", mod
       "But for rare refactorings you can use ${action(it)} and see a partial list of them."
     }
     task("Introduce Parameter") {
-      text("Suppose we want to replace this expression by parameter. So we need to choose <strong>$it...</strong>. " +
+      text("Suppose we want to replace this expression with a parameter. So we need to choose <strong>$it...</strong>. " +
            "Now simply type ${code("pa")} (as prefix of Parameter) to reduce proposed list.")
       triggerByUiComponentAndHighlight(highlightBorder = false, highlightInside = false) { ui: JList<*> ->
         ui.model.size > 0 && ui.model.getElementAt(0).toString().contains(it)
@@ -48,7 +48,7 @@ class PythonRefactorMenuLesson(module: Module) : KLesson("Refactoring menu", mod
     }
 
     task {
-      text("To complete refactoring you need to choose some name or leave it as default and press ${action("EditorEnter")}.")
+      text("To complete refactoring, you need to choose some name or leave it as default and press ${action("EditorEnter")}.")
       stateCheck {
         !hasInplaceRename()
       }
index 915473c8d087e7406a87b9aa6128b0e512f56fc6..8054bd0c121c7a01d481c93246aef8c1c024f3e0 100644 (file)
@@ -91,7 +91,7 @@ class PythonRenameLesson(module: Module) : KLesson("Rename", module, "Python") {
           TreeUtil.collapseAll(tree, 1)
         }
       }
-      text("In simple case PyCharm will just rename without confirmation. But in this sample PyCharm see two calls of  " +
+      text("In simple cases PyCharm will just rename without confirmation. But in this sample PyCharm sees two calls of  " +
            "${code("teams")} method for objects with unknown type. Expand <strong>Dynamic references</strong> item.")
 
       triggerByFoundPathAndHighlight { _: JTree, path: TreePath ->
@@ -140,7 +140,7 @@ class PythonRenameLesson(module: Module) : KLesson("Rename", module, "Python") {
 
     task {
       val result = replace?.let { template.replace("<name>", it).replace("<caret>", "") }
-      text("Now just finish rename with <strong>Do Refactor</strong> button.")
+      text("Now just finish the rename with the <strong>Do Refactor</strong> button.")
       stateCheck { editor.document.text == result }
       test {
         ideFrame {