Commit 77d1ed2
committed
feat: Format output as Markdown for improved readability
This commit updates the `scripts/gha/get_pr_review_comments.py` script
to format its entire output using Markdown. This significantly
improves the readability and structure of the comment data when
pasted into Markdown-aware systems.
Changes include:
- Comment attribution (user, ID, reply ID) is now an H3 heading
with bolding and code formatting.
- Metadata (Timestamp, Status, File, Line, URL) is presented as a
Markdown bulleted list with bold labels and appropriate formatting
for values (code ticks, links).
- "Diff Hunk Context" and "Comment Body" are now H4 headings.
- The diff hunk itself remains wrapped in triple backticks for
code block rendering.
- A Markdown horizontal rule (---) is used to separate individual
comments.
These changes make the script's output more organized and easier
to parse visually.1 parent 599845b commit 77d1ed2
1 file changed
Lines changed: 9 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
171 | 171 | | |
172 | 172 | | |
173 | 173 | | |
174 | | - | |
| 174 | + | |
175 | 175 | | |
176 | | - | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
177 | 181 | | |
178 | | - | |
179 | | - | |
180 | | - | |
181 | | - | |
182 | | - | |
183 | | - | |
| 182 | + | |
184 | 183 | | |
185 | 184 | | |
186 | 185 | | |
| |||
195 | 194 | | |
196 | 195 | | |
197 | 196 | | |
198 | | - | |
| 197 | + | |
199 | 198 | | |
200 | | - | |
| 199 | + | |
201 | 200 | | |
202 | 201 | | |
203 | 202 | | |
| |||
0 commit comments