mirror of
https://github.com/tiennm99/serena.git
synced 2026-10-15 04:18:56 +00:00
Mark some new tools as beta tools and denote in tool list
This commit is contained in:
1 parent
e39830df4d
commit
60067f3274
3 files changed
+21
-8
No files matched your search
@@ -153,9 +153,10 @@ def autogen_tool_list(target_filename = "01-about/035_tools.md"):
|
||||
with open(target_file, "w") as f:
|
||||
f.write("<!-- This file is auto-generated by docs/autogen_docs.py. Do not edit it manually. -->\n\n")
|
||||
f.write("# Tools\n\n")
|
||||
f.write("Find the full list of Serena's tools below. \n")
|
||||
f.write("Find the full list of Serena's tools below.\n\n")
|
||||
f.write("Note that in most configurations, only a subset of these tools will be enabled simultaneously.\n")
|
||||
f.write("Tools marked as optional are disabled by default.\n\n")
|
||||
f.write("Tools marked as *optional* are disabled by default.\n\n")
|
||||
f.write("Tools marked as [BETA] were recently introduced and may not be fully robust yet.\n\n")
|
||||
tools_by_module = ToolRegistry().get_registered_tools_by_module()
|
||||
priority_modules = {"serena.tools.symbol_tools": 1, "serena.tools.jetbrains_tools": 2}
|
||||
|
||||
@@ -166,7 +167,11 @@ def autogen_tool_list(target_filename = "01-about/035_tools.md"):
|
||||
module = module.replace("serena.tools.", "")
|
||||
text.with_line(f"* **{module}**")
|
||||
for tool in tools:
|
||||
info = " *(optional)*" if tool.is_optional else ""
|
||||
info = ""
|
||||
if tool.is_optional:
|
||||
info += " *(optional)*"
|
||||
if tool.is_beta:
|
||||
info += " [BETA]"
|
||||
text.with_line(f"* `{tool.tool_name}`{info}: {tool.class_docstring}", indent=2)
|
||||
f.write(text.build())
|
||||
|
||||
|
||||
Reference in new issue
Block a user