Fix markdown list indentation in notes2news.pl script
Maintainers usually reply within 3 days
@cvvergara is already working on this.
Since Sep 14, 2025.
Assessment
This issue has not been assessed yet.
Description
Problem
The NEWS.md file generated by the notes2news.pl script contains inconsistent markdown list indentation that violates markdownlint rule MD007.
Markdownlint Violations
Multiple lines in NEWS.md (lines 377-417) show indentation errors:
- Expected: 2 spaces for nested bullets
- Actual: 4 spaces for nested bullets
Example violations:
377-377: Unordered list indentation - Expected: 2; Actual: 4 (MD007)
381-381: Unordered list indentation - Expected: 2; Actual: 4 (MD007)
382-382: Unordered list indentation - Expected: 2; Actual: 4 (MD007)
Root Cause
If NEWS.md is generated by the notes2news.pl script, then the script needs to be updated to emit consistent 2-space indentation for nested markdown list items.
Solution
Modify notes2news.pl to:
- Use 2-space indentation for each nested level in markdown lists
- Ensure sub-bullets under top-level bullets are prefixed with exactly two spaces
- Maintain consistency across all generated markdown content
Reference
This issue was identified in PR #2970: https://github.com/pgRouting/pgrouting/pull/2970#discussion_r2347640433
Acceptance Criteria
-
notes2news.plscript updated to use 2-space markdown list indentation - Generated
NEWS.mdpasses markdownlint MD007 rule - All nested bullets consistently use 2-space increments
- Dominant language
- C++
- Stars
- 1.4k
- Forks
- 397
- Avg merge
- 2d 16h
- Merged PRs (30d)
- 8
Getting set up
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from pgRouting/pgrouting
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 3 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 3 days
-
Administrative Enhancement
Difficulty 1/5 Under an hour Newbie friendliness 80/100
Maintainers usually reply within 3 days
-
points_input Developers docPossibly taken @withaman69 claimed this 101 days ago. OpenC/C++ Developers Doc. good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
pgRouting/pgrouting#973 · 10 comments ·
Maintainers usually reply within 3 days
-
get_check_data developers docPossibly taken @withaman69 claimed this 102 days ago. OpenC/C++ Developers Doc. good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
pgRouting/pgrouting#972 · 7 comments ·
Maintainers usually reply within 3 days
All issues in pgRouting/pgrouting
Similar issues
-
std::fdim drops partial derivative w.r.t second argument in forward and reverse modePossibly taken @ADITYASINGH1206 claimed this today. Open
Difficulty 1/5 Under an hour Newbie friendliness 85/100
vgvassilev/clad#2534 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Maintainers usually reply within 1 day
-
HAP.cpp fixOpen
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
KLayout/klayout#2554 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day