Skip to content

Commit 971a9b2

Browse files
authored
fix: fixing more formatting on generated comment (#298)
1 parent e2deadf commit 971a9b2

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

scripts/generate-rst-comment.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -360,15 +360,18 @@ def generate_comment(rst_content: str, chapter: str, test_results: List[CodeTest
360360
361361
### 🗂️ Update Chapter Index
362362
363-
Update `{chapter_index_file}` to include {guideline_id}.rst.inc, like so:
363+
Update `{chapter_index_file}` to include `{guideline_id}.rst.inc`, like so:
364364
365365
```
366-
Expressions <- this should match {chapter_slug}
367-
===========
366+
Chapter Name Here <- chapter heading inside of `{chapter_index_file}`
367+
=================
368368
369369
.. include:: gui_7y0GAMmtMhch.rst.inc -| existing guidelines
370370
.. include:: gui_ADHABsmK9FXz.rst.inc |
371-
.. include:: gui_HDnAZ7EZ4z6G.rst.inc -|
371+
... |
372+
... |
373+
.. include:: gui_RHvQj8BHlz9b.rst.inc |
374+
.. include:: gui_dCquvqE1csI3.rst.inc -|
372375
.. include:: {guideline_id}.rst.inc <- your new guideline to add
373376
```"""
374377
else:

0 commit comments

Comments
 (0)