mirror of
https://github.com/tiennm99/serena.git
synced 2026-08-14 12:26:46 +00:00
Changelog [ci skip]
This commit is contained in:
committed by
Michael Panchenko
parent
c43a1a6f11
commit
fe5a888d49
@@ -22,6 +22,9 @@ Status of the `main` branch. Changes prior to the next official version change w
|
||||
* **Add support for Clojure**
|
||||
* Configuration:
|
||||
* Add option `web_dashboard_open_on_launch` (allowing the dashboard to be enabled without opening a browser window)
|
||||
* Add options `record_tool_usage_stats` and `token_count_estimator`
|
||||
* Dashboard:
|
||||
* Displaying tool usage statistics if enabled in the config
|
||||
|
||||
Fixes:
|
||||
* Fix `ExecuteShellCommandTool` and `GetCurrentConfigTool` hanging on Windows
|
||||
|
||||
@@ -19,6 +19,8 @@ prompt: |
|
||||
You can get information about available symbols by using the `get_symbols_overview` tool for finding top-level symbols in a file
|
||||
or directory, or by using `find_symbol` if you already know the symbol's name path. You generally try to read as little code as possible
|
||||
while still solving your task, meaning you only read the bodies when you need to, and after you have found the symbol you want to edit.
|
||||
Before calling symbolic reading tools, you should have a basic understanding of the repository structure that you can get from memories
|
||||
or by using the `list_dir` and `find_file` tools (or similar).
|
||||
For example, if you are working with python code and already know that you need to read the body of the constructor of the class Foo, you can directly
|
||||
use `find_symbol` with the name path `Foo/__init__` and `include_body=True`. If you don't know yet which methods in `Foo` you need to read or edit,
|
||||
you can use `find_symbol` with the name path `Foo`, `include_body=False` and `depth=1` to get all (top-level) methods of `Foo` before proceeding
|
||||
|
||||
@@ -113,6 +113,9 @@ class JetBrainsGetSymbolsOverviewTool(Tool, ToolMarkerOptional):
|
||||
"""
|
||||
Gets an overview of the top-level symbols in the given file.
|
||||
Calling this is often a good idea before more targeted reading, searching or editing operations on the code symbols.
|
||||
Before requesting a symbol overview, it is usually a good idea to narrow down the scope of the overview
|
||||
by first understanding the basic directory structure of the repository that you can get from memories
|
||||
or by using the `list_dir` and `find_file` tools (or similar).
|
||||
|
||||
:param relative_path: the relative path to the file to get the overview of
|
||||
:param max_answer_chars: max characters for the JSON result. If exceeded, no content is returned.
|
||||
|
||||
@@ -53,6 +53,9 @@ class GetSymbolsOverviewTool(Tool):
|
||||
For each analyzed file, we list the top-level symbols in the file (name_path, kind).
|
||||
Use this tool to get a high-level understanding of the code symbols.
|
||||
Calling this is often a good idea before more targeted reading, searching or editing operations on the code symbols.
|
||||
Before requesting a symbol overview, it is usually a good idea to narrow down the scope of the overview
|
||||
by first understanding the basic directory structure of the repository that you can get from memories
|
||||
or by using the `list_dir` and `find_file` tools (or similar).
|
||||
|
||||
:param relative_path: the relative path to the file or directory to get the overview of
|
||||
:param max_answer_chars: if the overview is longer than this number of characters,
|
||||
|
||||
Reference in New Issue
Block a user