9afd0ece63
* feat: turn summarize_code into generator * feat: extract run_code_graph_pipeline, update the pipeline * feat: minimal code graph example * refactor: update argument * refactor: move run_code_graph_pipeline to cognify/code_graph_pipeline * refactor: indentation and whitespace nits * refactor: add deprecated use comments and warnings * Structured code summarization * add missing prompt file * Remove summarization_model argument from summarize_code and fix typehinting * minor refactors --------- Co-authored-by: lxobr <122801072+lxobr@users.noreply.github.com> Co-authored-by: Vasilije <8619304+Vasilije1990@users.noreply.github.com> Co-authored-by: Igor Ilic <30923996+dexters1@users.noreply.github.com> Co-authored-by: Boris <boris@topoteretes.com>
10 lines
No EOL
841 B
Text
10 lines
No EOL
841 B
Text
You are an expert Python programmer and technical writer. Your task is to summarize the given Python code snippet or file.
|
|
The code may contain multiple imports, classes, functions, constants and logic. Provide a clear, structured explanation of its components
|
|
and their relationships.
|
|
|
|
Instructions:
|
|
Provide an overview: Start with a high-level summary of what the code does as a whole.
|
|
Break it down: Summarize each class and function individually, explaining their purpose and how they interact.
|
|
Describe the workflow: Outline how the classes and functions work together. Mention any control flow (e.g., main functions, entry points, loops).
|
|
Key features: Highlight important elements like arguments, return values, or unique logic.
|
|
Maintain clarity: Write in plain English for someone familiar with Python but unfamiliar with this code. |