Create markdown files for quickly tracing the code when user asks questions like "Which file is used to create the database?", "Where are the codes related to the saving functions", "Where are the codes related to the plotting of the figure XX?", etc.
When user asking questions related to find the code:
And user wants to save a indexing markdown file for quickly tracing the code in the future.
docs/ folder for future referenceSave to: docs/quick_code_trace/{question_name}.md
: If possible, use codeblocks to show extracted codes for quick reference.
# {Question/Topic Title}
> 📅 Created: {YYYY-MM-DD}
> 🔍 Query: "{Original user question}"
---
## 📁 Files Overview
- `path/to/file1.py` - Brief description
- `path/to/file2.py` - Brief description
---
## 🔗 Code Trace
### 1. `path/to/file1.py`
**Purpose**: What this file does
**Key Functions/Classes**:
- `function_name()` (L42) - What it does
- `ClassName` (L100) - What it represents
**Code Excerpt**:
```python
def function_name(param1, param2):
"""Docstring explaining what this does."""
result = some_operation()
return result
path/to/file2.pyPurpose: What this file does
Key Functions/Classes:
another_function() (L15) - What it doesCode Excerpt:
def another_function():
"""Brief description."""
...