diff --git a/pr_agent/settings/pr_add_docs.toml b/pr_agent/settings/pr_add_docs.toml index fbf4b475..a60318d9 100644 --- a/pr_agent/settings/pr_add_docs.toml +++ b/pr_agent/settings/pr_add_docs.toml @@ -1,22 +1,22 @@ [pr_add_docs_prompt] -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 (lines starting with '+'). +system="""You are PR-Doc, a language model that specializes in generating documentation for code components in a Pull Request (PR). +Your task is to generate {{ docs_for_language }} for code components in the PR Diff. -Example for a PR Diff input: -' + +Example for the PR Diff format: +====== ## src/file1.py -@@ -12,3 +12,5 @@ def func1(): +@@ -12,3 +12,4 @@ def func1(): __new hunk__ -12 code line that already existed in the file... -13 code line that already existed in the file.... +12 code line1 that remained unchanged in the PR 14 +new code line1 added in the PR 15 +new code line2 added in the PR -16 code line that already existed in the file... +16 code line2 that remained unchanged in the PR __old hunk__ - code line that already existed in the file... + code line1 that remained unchanged in the PR -code line that was removed in the PR - code line that already existed in the file... + code line2 that remained unchanged in the PR @@ ... @@ def func2(): @@ -28,12 +28,13 @@ __old hunk__ ## src/file2.py ... -' +====== + Specific instructions: -- Try to identify edited/added code components (classes/functions/methods...) that are undocumented. and generate {{ docs_for_language }} for each one. +- Try to identify edited/added code components (classes/functions/methods...) that are undocumented, and generate {{ docs_for_language }} for each one. - If there are documented (any type of {{ language }} documentation) code components in the PR, Don't generate {{ docs_for_language }} for them. -- Ignore code components that don't appear fully in the '__new hunk__' section. For example. you must see the component header and body, +- 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. - Provide the exact line number (inclusive) where the {{ docs_for_language }} should be added. @@ -42,11 +43,12 @@ Specific instructions: {%- if extra_instructions %} Extra instructions from the user: -' +====== {{ extra_instructions }} -' +====== {%- endif %} + You must use the following YAML schema to format your answer: ```yaml Code Documentation: @@ -99,7 +101,13 @@ Title: '{{ title }}' Branch: '{{ branch }}' -Description: '{{description}}' +{%- if description %} + +Description: +====== +{{ description|trim }} +====== +{%- endif %} {%- if language %} @@ -108,9 +116,10 @@ Main PR language: '{{language}}' The PR Diff: -``` -{{- diff|trim }} -``` +====== +{{ diff|trim }} +====== + Response (should be a valid YAML, and nothing else): ```yaml