Improve descriptions for most plugins

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

spyder/api/plugin_registration/_confpage.py

@@ -23,9 +23,9 @@ def setup_page(self):
         self.plugins_checkboxes = {}
 
         header_label = QLabel(
-            _("Here you can turn on/off any internal or external Spyder "
-              "plugin to disable functionality that is not desired or to have "
-              "a lighter experience.")
+            _("Disable a Spyder plugin (external or built-in) to prevent it "
+              "from loading until re-enabled here, to simplify the interface "
+              "or in case it causes problems.")
         )
         header_label.setWordWrap(True)
 
@@ -53,7 +53,7 @@ def setup_page(self):
                     description=PluginClass.get_description(),
                     icon=PluginClass.get_icon(),
                     widget=cb,
-                    additional_info=_("Core plugin")
+                    additional_info=_("Built-in")
                 )
             )
 

spyder/api/plugins/new_api.py

@@ -766,7 +766,7 @@ def get_description():
 
         Notes
         -----
-        This method needs to be decorated with `staticmethod`
+        This method needs to be decorated with `staticmethod`.
         """
         raise NotImplementedError('A plugin description must be defined!')
 

spyder/app/tests/spyder-boilerplate/spyder_boilerplate/spyder/plugin.py

@@ -122,7 +122,7 @@ class SpyderBoilerplate(SpyderDockablePlugin):
     # ------------------------------------------------------------------------
     @staticmethod
     def get_name():
-        return "Spyder boilerplate plugin."
+        return "Spyder boilerplate plugin"
 
     @staticmethod
     def get_description():

spyder/plugins/breakpoints/plugin.py

@@ -92,7 +92,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Manage code breakpoints in a unified pane.")
+        return _("Manage debugger breakpoints in a unified pane.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/completion/plugin.py

@@ -266,9 +266,9 @@ def get_name() -> str:
 
     @staticmethod
     def get_description() -> str:
-        return _('This plugin is in charge of handling and dispatching, as '
-                 'well as of receiving the responses of completion, linting, '
-                 'symbols and folding requests sent to multiple providers.')
+        return _('Handle code completion, analysis, formatting, introspection, '
+                 'folding and more via the Language Server Protocol and other '
+                 'providers.')
 
     @classmethod
     def get_icon(cls):

spyder/plugins/console/plugin.py

@@ -88,7 +88,7 @@ def get_icon(cls):
 
     @staticmethod
     def get_description():
-        return _('Internal console running Spyder.')
+        return _('An internal Python console running Spyder itself.')
 
     def on_initialize(self):
         widget = self.get_widget()

spyder/plugins/debugger/plugin.py

@@ -58,7 +58,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _('Display and explore frames while debugging.')
+        return _('View, explore and navigate stack frames while debugging.')
 
     @classmethod
     def get_icon(cls):

spyder/plugins/editor/plugin.py

@@ -652,8 +652,7 @@ def get_plugin_title():
     @staticmethod
     def get_description():
         return _(
-            "Edit Python, Markdown, Cython and many other types of plain text "
-            "files."
+            "Edit Python, Markdown, Cython and many other types of text files."
         )
 
     @classmethod

spyder/plugins/explorer/plugin.py

@@ -160,7 +160,7 @@ def get_name():
     @staticmethod
     def get_description():
         """Return the description of the explorer widget."""
-        return _("Explore filesystem in a tree view.")
+        return _("Explore your filesystem in a tree view.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/externalconsole/plugin.py

@@ -51,7 +51,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Run files in an external system terminal.")
+        return _("Run scripts in an external system terminal.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/help/plugin.py

@@ -64,8 +64,7 @@ def get_name():
     @staticmethod
     def get_description():
         return _(
-            "Get documentation for objects used in the editor or IPython "
-            "console."
+            "Get documentation for objects in the Editor and IPython console."
         )
 
     @classmethod

spyder/plugins/history/plugin.py

@@ -57,7 +57,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _('Provide command history for the IPython console.')
+        return _('View command history for the IPython console.')
 
     @classmethod
     def get_icon(cls):

spyder/plugins/ipythonconsole/plugin.py

@@ -194,8 +194,7 @@ def get_name():
     @staticmethod
     def get_description():
         return _(
-            "Run Python files interactively in different ways (whole file, by "
-            "cells or selections)."
+            "Run Python files, cells, code and commands interactively."
         )
 
     @classmethod

spyder/plugins/maininterpreter/plugin.py

@@ -47,8 +47,8 @@ def get_name():
     @staticmethod
     def get_description():
         return _(
-            "Manage default Python interpreter used by other plugins in "
-            "Spyder."
+            "Manage the default Python interpreter used to run, analyze and "
+            "profile your code in Spyder."
         )
 
     @classmethod

spyder/plugins/outlineexplorer/plugin.py

@@ -36,7 +36,9 @@ def get_name() -> str:
     @staticmethod
     def get_description() -> str:
         """Return the description of the outline explorer widget."""
-        return _("Explore functions, classes and methods in the current file.")
+        return _("Explore functions, classes and methods in open files. Note "
+                 "that if you disable the 'Completion and linting' plugin, "
+                 "this one won't work.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/plots/plugin.py

@@ -35,7 +35,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _('Display, explore and save console generated plots.')
+        return _('View, browse and save generated figures.')
 
     @classmethod
     def get_icon(cls):

spyder/plugins/preferences/plugin.py

@@ -268,7 +268,7 @@ def get_name() -> str:
 
     @staticmethod
     def get_description() -> str:
-        return _("Manage Spyder's main preferences dialog.")
+        return _("Manage Spyder's preferences.")
 
     @classmethod
     def get_icon(cls) -> QIcon:

spyder/plugins/pylint/plugin.py

@@ -69,7 +69,8 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Display static and real time code analysis results.")
+        return _("Analyze code and view the results from both static and "
+                 "real-time analysis.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/run/plugin.py

@@ -70,7 +70,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Manage run configuration to execute files.")
+        return _("Manage run configuration for executing files.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/shortcuts/plugin.py

@@ -65,7 +65,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Manage application, widget and actions shortcuts.")
+        return _("Manage application, pane and actions shortcuts.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/statusbar/plugin.py

@@ -59,7 +59,7 @@ def get_icon(cls):
 
     @staticmethod
     def get_description():
-        return _("Manage main window status bar.")
+        return _("Display the main window status bar.")
 
     def on_initialize(self):
         # --- Status widgets

spyder/plugins/switcher/plugin.py

@@ -110,7 +110,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Display and manage a multi-purpose switcher.")
+        return _("Quickly switch between files and other items.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/toolbar/plugin.py

@@ -46,7 +46,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _('Application toolbars management.')
+        return _('Manage application toolbars.')
 
     @classmethod
     def get_icon(cls):

spyder/plugins/tours/plugin.py

@@ -42,7 +42,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Provide interactive tours for the Spyder interface.")
+        return _("Provide interactive tours of the Spyder interface.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/variableexplorer/plugin.py

@@ -41,8 +41,8 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Display, explore, load and save global variables generated "
-                 "after execution")
+        return _("Explore, edit, save and load the lists, arrays, dataframes "
+                 "and other global variables generated by running your code.")
 
     @classmethod
     def get_icon(cls):

spyder/plugins/workingdirectory/plugin.py

@@ -63,8 +63,7 @@ def get_name():
 
     @staticmethod
     def get_description():
-        return _("Display and manage the current working directory used by "
-                 "other plugins in Spyder.")
+        return _("Manage the current working directory used in Spyder.")
 
     @classmethod
     def get_icon(cls):