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

autodocgenerator/engine/config/config.py

@@ -110,9 +110,10 @@ BASE_CUSTOM_DISCRIPTIONS = """
                 1. Use ONLY the provided Context to answer. 
                 2. If the requested information is not explicitly mentioned in the Context, or if you don't know the answer based on the provided data, respond with an empty string ("") or simply say "No information found". 
                 3. DO NOT use external knowledge or invent any logic that is not present in the text.
-                4. Do not provide any introductory or concluding remarks. If there is no info, output must be empty.
-                5. If you dont have any info about it return just !noinfo
-                6. Every response must start with exactly one <a name="CONTENT_DESCRIPTION"></a> tag. The CONTENT_DESCRIPTION must be a short, hyphenated summary of the actual information you are providing (e.g., "user-authentication-logic" instead of "auth.yml"). STRICT RULES:
+                4. Do not provide any introductory or concluding remarks.
+                5. If you dont have any info about it return just !noinfo Exception for "example usage": If the goal is to provide a usage example and the Context contains a class or function implementation, you are permitted to synthesize a code example by deriving the logic strictly from the provided implementation details.
+                7. Every response must start with exactly one <a name="CONTENT_DESCRIPTION"></a> tag. The CONTENT_DESCRIPTION must be a short, hyphenated summary of the actual information you are providing (e.g., "user-authentication-logic" instead of "auth.yml"). 
+STRICT RULES(This rules works only for <a name=""></a> tag):
 
 NO filenames or paths (e.g., forbidden: "autodocconfig.yml", "src/config").
 NO file extensions (e.g., forbidden: ".yml", ".md").

autodocgenerator/manage.py

@@ -67,15 +67,12 @@ class Manager:
         self.logger.log(InfoLog("Code mix generation completed."))
         self.progress_bar.update_task()
 
-
     def generete_doc_parts(self, max_symbols=5_000):
-
-
         full_code_mix = self.read_file_by_file_key("code_mix")
 
         self.logger.log(InfoLog("Starting synchronous documentation generation by parts..."))
         result = gen_doc_parts(full_code_mix,
-                                max_symbols, self.sync_model, 
+                                max_symbols, self.sync_model, self.config.get_project_settings(),
                                 self.config.language, self.progress_bar)
             
         self.logger.log(InfoLog("Documentation generation by parts completed."))

autodocgenerator/preprocessor/spliter.py

@@ -3,6 +3,7 @@ from ..engine.config.config import BASE_PART_COMPLITE_TEXT
 import asyncio
 from ..ui.progress_base import BaseProgress
 from ..ui.logging import BaseLogger, InfoLog, ErrorLog, WarningLog
+from .settings import ProjectSettings
 
 
 def split_data(data: str, max_symbols: int) -> list[str]:
@@ -40,7 +41,7 @@ def split_data(data: str, max_symbols: int) -> list[str]:
 
     return split_objects
 
-def write_docs_by_parts(part: str, model: Model, prev_info: str = None, language: str = "en"):
+def write_docs_by_parts(part: str, model: Model, project_settings: ProjectSettings, prev_info: str = None, language: str = "en"):
     logger = BaseLogger()
     logger.log(InfoLog("Generating documentation for a part..."))
     prompt = [
@@ -48,6 +49,10 @@ def write_docs_by_parts(part: str, model: Model, prev_info: str = None, language
                 "role": "system",
                 "content": f"For the following task use language {language}"
             },
+            {
+                "role": "system",
+                "content": f"global project info: {project_settings.prompt}"
+            },
             {
                 "role": "system",
                 "content": BASE_PART_COMPLITE_TEXT
@@ -121,7 +126,7 @@ async def async_write_docs_by_parts(part: str, async_model: AsyncModel, global_i
         return answer
 
 
-def gen_doc_parts(full_code_mix, max_symbols, model: Model, language, progress_bar: BaseProgress):
+def gen_doc_parts(full_code_mix, max_symbols, model: Model, project_settings: ProjectSettings,  language, progress_bar: BaseProgress):
     splited_data = split_data(full_code_mix, max_symbols)
     result = None
     logger = BaseLogger()
@@ -131,7 +136,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(el, model, result, language)
+        result = write_docs_by_parts(el, model, project_settings, result, language)
         all_result += result
         all_result += "\n\n"