tiennm99/serena
1
0 Fork 0
mirror of https://github.com/tiennm99/serena.git synced 2026-10-13 08:15:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

JetBrainsPluginClient.get_symbols_overview: Add parameter include_file_documentation

Browse Source
This commit is contained in:
Dominik Jain authored and Dominik Jain committed 2026-01-08 15:48:46 +01:00
1 parent 25db8275a0
commit e1e7c233ed
1 file changed
+3 -2
Download Patch File Download Diff File Expand all files Collapse all files
src/serena/tools/jetbrains_plugin_client.py
+3 -2
View File
@@ -220,12 +220,13 @@ class JetBrainsPluginClient(ToStringMixin):
request_data = {"namePath": name_path, "relativePath": relative_path, "includeQuickInfo": include_quick_info}
return cast(jb.SymbolCollectionResponse, self._make_request("POST", "/findReferences", request_data))
def get_symbols_overview(self, relative_path: str, depth: int) -> jb.SymbolCollectionResponse:
def get_symbols_overview(self, relative_path: str, depth: int, include_file_documentation: bool = False) -> jb.SymbolCollectionResponse:
"""
:param relative_path: the relative path to a source file
:param depth: the depth of children to include (0 = no children)
:param include_file_documentation: whether to include the file's documentation string (if any)
"""
request_data = {"relativePath": relative_path, "depth": depth}
request_data = {"relativePath": relative_path, "depth": depth, "includeFileDocumentation": include_file_documentation}
return cast(jb.SymbolCollectionResponse, self._make_request("POST", "/getSymbolsOverview", request_data))
def get_supertypes(