autodocgenerator 0.9.0.0__py3-none-any.whl → 0.9.0.1__py3-none-any.whl

autodocgenerator/engine/config/config.py

@@ -9,28 +9,34 @@ You should understand, that it is not full code, it is just part
 Do NOT skip details; analyze everything that appears in the snippet.
 """
 
-BASE_PART_COMPLITE_TEXT = """Revised Documentation Prompt
-Role: You are a senior technical writer. Input: You will receive a specific code snippet representing a fragment of a larger system.
-Task: Write clear, structured, and hierarchical documentation for this fragment. Length: 0.7–1k characters (keep it tight).
-
-Content Requirements:
-Component Responsibility: Define exactly what this specific fragment does.
-Interactions: Describe how this piece communicates with the rest of the system.
-Technical Details: Detail key functions, classes, and logic flows present in the snippet.
-Data Flow: Outline inputs, outputs, side effects, and logic assumptions.
-
-Constraint - No Generic Headers (CRITICAL):
-DO NOT use generic or global topic headers such as "Overview," "Core," "Introduction," "Background," or "System Summary."
-All headings must be specific to the functionality of the code fragment provided.
-
-Context & Style:
-Use the global system description as the primary context, but do not restate it. Focus exclusively on the fragment.
-Write for developers who are new to the codebase.
-Maintain high technical accuracy and a concise, professional tone.
-
-Formatting:
-Use Markdown for structure.
-Include HTML anchors near titles: <a name="specific-title"></a> \n ## Specific Title."""
+BASE_PART_COMPLITE_TEXT = """
+Role: You are a Senior Technical Writer & System Architect. Objective: Create high-fidelity, visually polished, and strictly factual documentation for a specific code fragment.
+
+1. STRICT GROUNDING & ACCURACY (NO HALLUCINATIONS):
+Source Truth: Use ONLY the provided code snippet and the explicit global context.
+Zero Assumption Policy: If a function's origin, a variable's purpose, or a data source is not explicitly present in the provided text, do not invent it. If information is missing, omit the section or state: "Information not present in the provided fragment."
+Context Lock: Do not use general knowledge about external libraries unless their specific usage is visible in the code.
+
+2. VISUAL STRUCTURE & MD STYLE:
+Layout: Use a highly scannable, hierarchical Markdown structure.
+Data Visualization: Present Inputs, Outputs, and Parameters in a Markdown Table (Columns: Entity, Type, Role, Notes).
+Emphasis: Use backticks for code symbols, bolding for key terms, and > Blockquotes for critical logic assumptions or warnings.
+Navigation: Every heading must be preceded by an HTML anchor: <a name="unique-id"></a> \n ## Specific Heading.
+
+3. CONTENT REQUIREMENTS (0.7–1k characters):
+Specific Component Responsibility: Define the exact functional role of this fragment within the system.
+Visible Interactions: Describe how this piece communicates with other parts of the system based only on the snippet.
+Technical Logic Flow: A step-by-step breakdown of the classes, functions, and internal logic.
+Data Contract: Detailed flow of inputs, outputs, and side effects in table format.
+
+4. CRITICAL CONSTRAINT - NO GENERIC HEADERS:
+Forbidden: "Overview", "Introduction", "Background", "Technical Details", "Summary", "Core".
+Required: Use headers that describe the specific functionality (e.g., ## [Component Name] Request Validation or ## Stream Processing Pipeline).
+
+5. TONE & STYLE:
+Professional, technical, and laconic.
+Write for developers who need to understand the fragment's implementation instantly.
+Focus exclusively on the fragment; do not restate the global system description."""
 
 BASE_INTRODACTION_CREATE_LINKS = """
 Role: Senior Technical Solutions Architect.

autodocgenerator/preprocessor/spliter.py

@@ -40,13 +40,13 @@ def split_data(data: str, max_symbols: int) -> list[str]:
 
     return split_objects
 
-def write_docs_by_parts(part_id: int, part: str, model: Model, prev_info: str = None, language: str = "en"):
+def write_docs_by_parts(part: str, model: Model, prev_info: str = None, language: str = "en"):
     logger = BaseLogger()
     logger.log(InfoLog("Generating documentation for a part..."))
     prompt = [
             {
                 "role": "system",
-                "content": f"For the following task use language {language}. your part id is {part_id}"
+                "content": f"For the following task use language {language}"
             },
             {
                 "role": "system",
@@ -89,10 +89,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
                 "role": "system",
                 "content": BASE_PART_COMPLITE_TEXT
             },
-            # {
-                # "role": "system",
-                # "content": global_info
-            # },
+           
             {
                 "role": "user",
                 "content": part
@@ -102,7 +99,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
         if prev_info is not None:
             prompt.append({
                     "role": "system",
-                    "content": f"it is last part of documentation that you have write before{prev_info}"
+                    "content": f"it is last part of documentation that you have write before {prev_info}"
                 })
 
         prompt.append({
@@ -134,7 +131,7 @@ def gen_doc_parts(full_code_mix, max_symbols, model: Model, language, progress_b
     
     all_result = ""
     for i, el in enumerate(splited_data):
-        result = write_docs_by_parts(i + 1, el, model, result, language)
+        result = write_docs_by_parts(el, model, result, language)
         all_result += result
         all_result += "\n\n"