Fix README delimiter in sort.py to prevent CI README corruption #2725
+91
−74
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ownloads/awesome-python/sort.py:0:0-0:0) to prevent CI README corruption [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. Co-Authored-By: S. M. Mohiuddin Khan Shiam <147746955+mohiuddin-khan-shiam@users.noreply.github.com>
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.
JaydenChao101
approved these changes
Jun 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix README delimiter in sort.py to prevent CI README corruption
Description
sort.py expected the string
"- - -"to split the README intoTable-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:
---.CI now runs
python sort.pywithout errors and the README remains intact.