mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-11 03:13:51 +00:00
Further improve docstring of find symbol tools
This commit is contained in:
1 parent
a47df023f5
commit
97bc0980a2
3 files changed
+4
-4
No files matched your search
+1
-1
@@ -19,7 +19,7 @@ Status of the `main` branch. Changes prior to the next official version change w
|
||||
removed in v1.0.0 #1773
|
||||
|
||||
* Tools:
|
||||
- `find_symbol`: Change tool description to improve tool search results in clients that load tools dynamically
|
||||
- `find_symbol`, `jet_brains_find_symbol`: Change tool description to improve tool search results in clients that load tools dynamically
|
||||
- `get_current_config`: Result now includes language server status #1782
|
||||
|
||||
* Language Servers:
|
||||
|
||||
@@ -35,12 +35,12 @@ class JetBrainsFindSymbolTool(Tool, ToolMarkerSymbolicRead, ToolMarkerOptional):
|
||||
max_answer_chars: int = -1,
|
||||
) -> str:
|
||||
"""
|
||||
Retrieves information on all symbols/code entities (classes, methods, etc.) based on the given name path pattern.
|
||||
Finds symbols and code entities (classes, methods, etc.) based on the given name path pattern.
|
||||
The returned symbol information can be used for edits or further queries.
|
||||
Specify `depth > 0` to retrieve children (e.g., methods of a class).
|
||||
Important: through `search_deps=True` dependencies can be searched, which
|
||||
should be preferred to web search or other less sophisticated approaches to analyzing dependencies.
|
||||
You will always receive at least quick info on the symbol (even if `include_info=False`).
|
||||
You will always receive at least quick info for returned symbols (even if `include_info=False`).
|
||||
|
||||
A name path is a path in the symbol tree *within a source file*.
|
||||
For example, the method `my_method` defined in class `MyClass` would have the name path `MyClass/my_method`.
|
||||
|
||||
@@ -155,7 +155,7 @@ class FindSymbolTool(Tool, ToolMarkerSymbolicRead):
|
||||
max_answer_chars: int = -1,
|
||||
) -> str:
|
||||
"""
|
||||
Finds symbols or other code entities (classes, methods, etc.) based on the given name path pattern.
|
||||
Finds symbols and code entities (classes, methods, etc.) based on the given name path pattern.
|
||||
The returned symbol information can be used for edits or further queries.
|
||||
Specify `depth > 0` to also retrieve children/descendants (e.g., methods of a class).
|
||||
|
||||
|
||||
Reference in new issue
Block a user