Merge pull request #1039 from KennyDizi/main

Enhance and clarify descriptions for relevant file and language fields across prompts

pr_agent/settings/pr_add_docs.toml

@@ -56,7 +56,7 @@ Code Documentation:
   items:
     relevant file:
       type: string
-      description: the relevant file full path
+      description: The full file path of the relevant file.
     relevant line:
       type: integer
       description: |-

pr_agent/settings/pr_code_suggestions_prompts.toml

@@ -57,8 +57,8 @@ Extra instructions from the user, that should be taken into account with high pr
 The output must be a YAML object equivalent to type $PRCodeSuggestions, according to the following Pydantic definitions:
 =====
 class CodeSuggestion(BaseModel):
-    relevant_file: str = Field(description="the relevant file full path")
-    language: str = Field(description="the code language of the relevant file")
+    relevant_file: str = Field(description="The full file path of the relevant file.")
+    language: str = Field(description="The programming language of the relevant file.")
     suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR")
     existing_code: str = Field(description="a short code snippet, demonstrating the relevant code lines from a '__new hunk__' section. It must be without line numbers. Use abbreviations if needed")
     improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant 'existing_code' lines in '__new hunk__' code after applying the suggestion")
@@ -171,8 +171,8 @@ Extra instructions from the user, that should be taken into account with high pr
 The output must be a YAML object equivalent to type $PRCodeSuggestions, according to the following Pydantic definitions:
 =====
 class CodeSuggestion(BaseModel):
-    relevant_file: str = Field(description="the relevant file full path")
-    language: str = Field(description="the code language of the relevant file")
+    relevant_file: str = Field(description="The full file path of the relevant file.")
+    language: str = Field(description="The programming language of the relevant file.")
     suggestion_content: str = Field(description="an actionable suggestion for meaningfully improving the new code introduced in the PR. Don't present here actual code snippets, just the suggestion. Be short and concise ")
     existing_code: str = Field(description="a short code snippet, demonstrating the relevant code lines from a '__new hunk__' section. It must be without line numbers. Use abbreviations ("...") if needed")
     improved_code: str = Field(description="a new code snippet, that can be used to replace the relevant 'existing_code' lines in '__new hunk__' code after applying the suggestion")

pr_agent/settings/pr_description_prompts.toml

@@ -38,8 +38,8 @@ class PRType(str, Enum):
 {%- if enable_semantic_files_types %}
 
 class FileDescription(BaseModel):
-    filename: str = Field(description="the relevant file full path")
-    language: str = Field(description="the relevant file language")
+    filename: str = Field(description="The full file path of the relevant file.")
+    language: str = Field(description="The programming language of the relevant file.")
     changes_summary: str = Field(description="concise summary of the changes in the relevant file, in bullet points (1-4 bullet points).")
     changes_title: str = Field(description="an informative title for the changes in the files, describing its main theme (5-10 words).")
     label: str = Field(description="a single semantic label that represents a type of code changes that occurred in the File. Possible values (partial list): 'bug fix', 'tests', 'enhancement', 'documentation', 'error handling', 'configuration changes', 'dependencies', 'formatting', 'miscellaneous', ...")

pr_agent/settings/pr_reviewer_prompts.toml

@@ -78,8 +78,8 @@ class Review(BaseModel):
 {%- if num_code_suggestions > 0 %}
 
 class CodeSuggestion(BaseModel):
-    relevant_file: str = Field(description="the relevant file full path")
-    language: str = Field(description="the language of the relevant file")
+    relevant_file: str = Field(description="The full file path of the relevant file.")
+    language: str = Field(description="The programming language of the relevant file.")
     suggestion: str = Field(description="a concrete suggestion for meaningfully improving the new PR code. Also describe how, specifically, the suggestion can be applied to new PR code. Add tags with importance measure that matches each suggestion ('important' or 'medium'). Do not make suggestions for updating or adding docstrings, renaming PR title and description, or linter like.")
     relevant_line: str = Field(description="a single code line taken from the relevant file, to which the suggestion applies. The code line should start with a '+'. Make sure to output the line exactly as it appears in the relevant file")
 {%- endif %}