xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-05 05:10:38 +08:00
Code Issues Packages Projects Releases Wiki Activity

add configurable docstring style

Browse Source
This commit is contained in:
Hussam.lawen
2023-09-28 20:58:37 +03:00
parent bb12c75431
commit cd3527f7d4
2 changed files with 8 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
pr_agent/settings/configuration.toml
View File

@ -49,6 +49,7 @@ final_clip_factor = 0.9
[pr_add_docs_prompt] # /add_docs # [pr_add_docs_prompt] # /add_docs #
extra_instructions = "" extra_instructions = ""
docs_style = "Google Style" # "Google Style", "Numpy Style", "Sphinx Style", "PEP257", "reStructuredText"
[pr_update_changelog] # /update_changelog # [pr_update_changelog] # /update_changelog #
push_changelog_changes=false push_changelog_changes=false

14
pr_agent/tools/pr_add_docs.py
View File

@ -39,7 +39,7 @@ class PRAddDocs:
"diff": "", # empty diff for initial calculation "diff": "", # empty diff for initial calculation
"extra_instructions": get_settings().pr_add_docs_prompt.extra_instructions, "extra_instructions": get_settings().pr_add_docs_prompt.extra_instructions,
"commit_messages_str": self.git_provider.get_commit_messages(), "commit_messages_str": self.git_provider.get_commit_messages(),
'docs_for_language': get_docs_for_language(self.main_language), 'docs_for_language': get_docs_for_language(self.main_language, get_settings().pr_add_docs_prompt.docs_style),
} }
self.token_handler = TokenHandler(self.git_provider.pr, self.token_handler = TokenHandler(self.git_provider.pr,
self.vars, self.vars,
@ -183,15 +183,15 @@ class PRAddDocs:
return data return data
def get_docs_for_language(language): def get_docs_for_language(language, style):
language = language.lower() language = language.lower()
if language == 'java': if language == 'java':
return "javadocs" return "Javadocs"
elif language in ['python', 'lisp', 'clojure']: elif language in ['python', 'lisp', 'clojure']:
return "docstrings" return f"Docstring ({style})"
elif language in ['javascript', 'typescript']: elif language in ['javascript', 'typescript']:
return "jsdocs" return "JSdocs"
elif language == 'c++': elif language == 'c++':
return "doxygen" return "Doxygen"
else: else:
return "docs" return "Docs"