mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-13 18:16:10 +00:00
Improve symbolic tool class docstrings to make the symbolic backend clear
This commit is contained in:
1 parent
3eda628eb6
commit
47cdb297ed
2 files changed
+6
-6
No files matched your search
@@ -6,7 +6,7 @@ from serena.tools.jetbrains_plugin_client import JetBrainsPluginClient
|
||||
|
||||
class JetBrainsFindSymbolTool(Tool, ToolMarkerSymbolicRead, ToolMarkerOptional):
|
||||
"""
|
||||
Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
||||
Performs a global (or local) search for symbols using the JetBrains backend
|
||||
"""
|
||||
|
||||
def apply(
|
||||
@@ -73,7 +73,7 @@ class JetBrainsFindSymbolTool(Tool, ToolMarkerSymbolicRead, ToolMarkerOptional):
|
||||
|
||||
class JetBrainsFindReferencingSymbolsTool(Tool, ToolMarkerSymbolicRead, ToolMarkerOptional):
|
||||
"""
|
||||
Finds symbols that reference the given symbol
|
||||
Finds symbols that reference the given symbol using the JetBrains backend
|
||||
"""
|
||||
|
||||
def apply(
|
||||
@@ -104,7 +104,7 @@ class JetBrainsFindReferencingSymbolsTool(Tool, ToolMarkerSymbolicRead, ToolMark
|
||||
|
||||
class JetBrainsGetSymbolsOverviewTool(Tool, ToolMarkerSymbolicRead, ToolMarkerOptional):
|
||||
"""
|
||||
Retrieves an overview of the top-level symbols within a specified file
|
||||
Retrieves an overview of the top-level symbols within a specified file using the JetBrains backend
|
||||
"""
|
||||
|
||||
def apply(
|
||||
|
||||
@@ -79,7 +79,7 @@ class GetSymbolsOverviewTool(Tool, ToolMarkerSymbolicRead):
|
||||
|
||||
class FindSymbolTool(Tool, ToolMarkerSymbolicRead):
|
||||
"""
|
||||
Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
||||
Performs a global (or local) search using the language server backend.
|
||||
"""
|
||||
|
||||
# noinspection PyDefaultArgument
|
||||
@@ -163,7 +163,7 @@ class FindSymbolTool(Tool, ToolMarkerSymbolicRead):
|
||||
|
||||
class FindReferencingSymbolsTool(Tool, ToolMarkerSymbolicRead):
|
||||
"""
|
||||
Finds symbols that reference the symbol at the given location (optionally filtered by type).
|
||||
Finds symbols that reference the given symbol using the language server backend
|
||||
"""
|
||||
|
||||
# noinspection PyDefaultArgument
|
||||
@@ -216,7 +216,7 @@ class FindReferencingSymbolsTool(Tool, ToolMarkerSymbolicRead):
|
||||
|
||||
class ReplaceSymbolBodyTool(Tool, ToolMarkerSymbolicEdit):
|
||||
"""
|
||||
Replaces the full definition of a symbol.
|
||||
Replaces the full definition of a symbol using the language server backend.
|
||||
"""
|
||||
|
||||
def apply(
|
||||
|
||||
Reference in new issue
Block a user