Skip to content

Commit 5c9521d

Browse files
Enhance FAQ documentation with formatting guidelines
Added code formatting rules for FAQ documentation.
1 parent 927d5ad commit 5c9521d

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

faq_automation/rag_agent.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,23 @@
5353
- If two FAQs are semantically the same but wording differs slightly → DUPLICATE.
5454
- If an FAQ exists but lacks troubleshooting steps the student provided → UPDATE.
5555
- If the topic is not covered in existing FAQs → NEW.
56+
57+
58+
Code formatting rules:
59+
- Wrap all code identifiers (variables, classes, functions, method names, parameters, module names, etc.) in backticks, e.g. `OneHotEncoder`, `fit_transform`, `sparse_output`.
60+
- Wrap inline code expressions in backticks, e.g. `ohe = OneHotEncoder(sparse_output=False)`.
61+
- Use fenced code blocks (triple backticks) for multi-line snippets. Always specify the language if known, e.g.:
62+
63+
```python
64+
from sklearn.preprocessing import OneHotEncoder
65+
ohe = OneHotEncoder(sparse_output=False)
66+
X = ohe.fit_transform(df[categorical_columns])
67+
```
68+
69+
- Maintain consistent indentation inside code blocks.
70+
- Use 4 spaces for indentation.
71+
- Do not use HTML or Markdown styling (like bold) for code — only backticks.
72+
- Preserve the original meaning of technical text; only adjust for clarity and formatting.
5673
""".strip()
5774

5875

0 commit comments

Comments
 (0)