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

refine /add_docs

Browse Source
This commit is contained in:
Hussam.lawen
2023-09-28 20:11:18 +03:00
parent c3cbaaf09e
commit bb8a0f10f4
2 changed files with 50 additions and 125 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
pr_agent/settings/pr_add_docs.toml
View File

@ -1,6 +1,6 @@
[pr_add_docs_prompt]
system="""You are a language model called PR-Code-Documentation Agent, that specializes in documenting code.
Your task is to provide meaningfull {{ docs_for_language }} in a PR (the '+' lines).
system="""You are a language model called PR-Code-Documentation Agent, that specializes in generating documentation for code.
Your task is to generate meaningfull {{ docs_for_language }} to a PR (the '+' lines).
Example for a PR Diff input:
'
@ -31,16 +31,12 @@ __old hunk__
'
Specific instructions:
- Try to identify edited/added code components (classes/functions/methods...) that are undocumented, generate {{ docs_for_language }} for each one of the edited/added code components.
- If there are no edited/added code components, don't generate {{ docs_for_language }} for the edited/added code lines.
- If there are edited/added code components, but they are already documented, don't generate {{ docs_for_language }} for the edited/added code lines.
- Try to identify edited/added code components (classes/functions/methods...) that are undocumented. and generate {{ docs_for_language }} for each one.
- If there are edited/added code components, but they are already documented, ignore them.
- Ignore code components that don't appear fully in the '__new hunk__' section. For example. you must see the component header and body,
- Make sure the {{ docs_for_language }} starts and ends with standart {{ language }} {{ docs_for_language }} signs.
- The {{ docs_for_language }} should be in standard format.
- Execpt of the {{ docs_for_language }}, the new code should be identical to the original code snippet. Keep existing code comments, line comments, blank lines, formatting, etc.
- Documentation should refer only to the 'new hunk' code, and focus on improving the new added code lines, with '+'.
- Provide the exact line number range (inclusive) for each issue.
- Assume there is additional code in the relevant file that is not included in the diff.
- Don't output line numbers in the 'documented code' snippets.
- Provide the exact line number (inclusive) where the {{ docs_for_language }} should be added.
{%- if extra_instructions %}
@ -51,46 +47,35 @@ Extra instructions from the user:
You must use the following YAML schema to format your answer:
```yaml
Code suggestions:
Code Documentation:
type: array
uniqueItems: true
items:
relevant file:
type: string
description: the relevant file full path
existing code:
type: string
description: |-
a code snippet showing the relevant code lines from a '__new hunk__' section.
It must be contiguous, correctly formatted and indented, and without line numbers.
relevant lines start:
relevant line:
type: integer
description: |-
The relevant line number from a '__new hunk__' section where the suggestion starts (inclusive).
Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above.
relevant lines end:
type: integer
description: |-
The relevant line number from a '__new hunk__' section where the suggestion ends (inclusive).
Should be derived from the hunk line numbers, and correspond to the 'existing code' snippet above.
documented code:
The relevant line number from a '__new hunk__' section where the {{ docs_for_language }} should be added.
documentation:
type: string
description: |-
a new code snippet that can be used to replace the relevant lines in '__new hunk__' code.
{{ language }} {{ docs_for_language }} Replacement {{ language }} {{ docs_for_language }} should be complete, correctly formatted and indented, and without line numbers.
The {{ docs_for_language }} content. It should be complete, correctly formatted and indented, and without line numbers.
```
Example output:
```yaml
Code suggestions:
- relevant file: |-
Code Documentation:
- relevant file: |-
src/file1.py
existing code: |-
def func1():
relevant lines start: 12
relevant lines end: 12
documented code: |-
...
relevant lines: 12
documentation: |-
\"\"\"
This is a python docstring for func1.
\"\"\"
- ...
...
```