[PR #2725] Fix README delimiter in sort.py to prevent CI README corruption #2038

New Issue

GiteaMirror · 2025-11-06T13:28:16-06:00

GiteaMirror commented

2025-11-06 13:28:16 -06:00

📋 Pull Request Information

Original PR: https://github.com/vinta/awesome-python/pull/2725
Author: @mohiuddin-khan-shiam
Created: 6/29/2025
Status: 🔄 Open

Base: master ← Head: master

📝 Commits (2)

48fc448 Fix README delimiter in sort.py to prevent CI README corruption
b1c225f Fix README delimiter in sort.py to prevent CI README corruption

📊 Changes

2 files changed (+91 additions, -74 deletions)

View changed files

📝 README.md (+74 -71)
📝 sort.py (+17 -3)

📄 Description

Fix README delimiter in sort.py to prevent CI README corruption

Description

sort.py expected the string "- - -" to split the README into
Table-of-Contents and body, but the markdown file actually uses the
standard horizontal rule ---.
This mismatch caused the script (run in CI) to mis-process the README,
leading to corrupted documentation and potential IndexErrors.

Changes made:

Replaced the obsolete delimiter with ---.
Added a safe fallback when the delimiter is absent.
Preserved original formatting by re-inserting the exact delimiter.

CI now runs python sort.py without errors and the README remains intact.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/vinta/awesome-python/pull/2725 **Author:** [@mohiuddin-khan-shiam](https://github.com/mohiuddin-khan-shiam) **Created:** 6/29/2025 **Status:** 🔄 Open **Base:** `master` ← **Head:** `master` --- ### 📝 Commits (2) - [`48fc448`](https://github.com/vinta/awesome-python/commit/48fc4486e0255ac0e2860b39daa7c87cbe1dfa4d) Fix README delimiter in [sort.py](cci:7://file:///c:/Users/T2430514/Downloads/awesome-python/sort.py:0:0-0:0) to prevent CI README corruption - [`b1c225f`](https://github.com/vinta/awesome-python/commit/b1c225f140d334981e6f32570aa8018b519b2b95) Fix README delimiter in sort.py to prevent CI README corruption ### 📊 Changes **2 files changed** (+91 additions, -74 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+74 -71) 📝 `sort.py` (+17 -3) </details> ### 📄 Description ### Fix README delimiter in [sort.py](cci:7://file:///c:/Users/T2430514/Downloads/awesome-python/sort.py:0:0-0:0) to prevent CI README corruption #### Description [sort.py](cci:7://file:///c:/Users/T2430514/Downloads/awesome-python/sort.py:0:0-0:0) expected the string `"- - -"` to split the README into Table-of-Contents and body, but the markdown file actually uses the standard horizontal rule `---`. This mismatch caused the script (run in CI) to mis-process the README, leading to corrupted documentation and potential `IndexError`s. Changes made: * Replaced the obsolete delimiter with `---`. * Added a safe fallback when the delimiter is absent. * Preserved original formatting by re-inserting the exact delimiter. CI now runs `python sort.py` without errors and the README remains intact. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2025-11-06 13:28:16 -06:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/awesome-python#2038