Skip to content

Commit f9c1751

Browse files
authored
Add label to identify devtale generated docstrings (#54)
1 parent a1cb4b3 commit f9c1751

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

cli.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
PHPAggregator,
1414
PythonAggregator,
1515
)
16-
from devtale.constants import ALLOWED_EXTENSIONS, LANGUAGES
16+
from devtale.constants import ALLOWED_EXTENSIONS, DOCSTRING_LABEL, LANGUAGES
1717
from devtale.utils import (
1818
build_project_tree,
1919
extract_code_elements,
@@ -350,7 +350,9 @@ def process_file(
350350

351351
logger.info("add dev tale summary")
352352
summaries = split_text(str(code_elements_dict["summary"]), chunk_size=9000)
353-
tale["file_docstring"] = redact_tale_information("top-level", summaries)["text"]
353+
tale["file_docstring"] = (
354+
DOCSTRING_LABEL + "\n" + redact_tale_information("top-level", summaries)["text"]
355+
)
354356

355357
logger.info(f"save dev tale in: {save_path}")
356358
with open(save_path, "w") as json_file:

devtale/constants.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,5 @@
1010
".go": Language.GO,
1111
".js": Language.JS,
1212
}
13+
14+
DOCSTRING_LABEL = "@DEVTALE-GENERATED:"

devtale/utils.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
from langchain.output_parsers import PydanticOutputParser
1010
from langchain.text_splitter import RecursiveCharacterTextSplitter
1111

12+
from devtale.constants import DOCSTRING_LABEL
1213
from devtale.schema import FileDocumentation
1314
from devtale.templates import (
1415
CODE_EXTRACTOR_TEMPLATE,
@@ -186,6 +187,9 @@ def fuse_tales(tales_list, code, code_elements_dict):
186187
class_name, code, code_elements_dict["classes"]
187188
):
188189
unique_classes.add(class_name)
190+
class_info["class_docstring"] = (
191+
DOCSTRING_LABEL + "\n" + class_info["class_docstring"]
192+
)
189193
fused_tale["classes"].append(class_info)
190194
else:
191195
if tale not in errors:
@@ -199,6 +203,9 @@ def fuse_tales(tales_list, code, code_elements_dict):
199203
method_name, code, code_elements_dict["methods"]
200204
):
201205
unique_methods.add(method_name)
206+
method_info["method_docstring"] = (
207+
DOCSTRING_LABEL + "\n" + method_info["method_docstring"]
208+
)
202209
fused_tale["methods"].append(method_info)
203210
else:
204211
if tale not in errors:

0 commit comments

Comments
 (0)