Optimize Markdown ToC checker script #886
Open
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
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
|
recheck |
|
@maintainers Could you please review and approve this PR? The CLA has been signed, and all checks have passed. Thank you! |
bolinfest
requested changes
May 13, 2025
| return 0 | ||
|
|
||
|
|
||
| def main(): |
There was a problem hiding this comment.
Please reorganize main() as I had it before:
- Top of file so reader does not have to dig to the end of the file to figure out what arguments this script accepts.
- As good practice,
main()should not callsys.exit()itself. That behavior should be restricted toif __name__ == "__main__"
| slug = text.lower() | ||
| # normalize spaces and dashes | ||
| slug = slug.replace("\u00a0", " ") | ||
| level, title = len(m.group(1)), m.group(2).strip() |
There was a problem hiding this comment.
please keep these as separate lines as before
| print(line) | ||
| # Show diff | ||
| print("ERROR: ToC out of date. Diff:") | ||
| for ln in unified_diff(current, expected, fromfile="existing ToC", tofile="generated ToC", lineterm=""): |
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.
Optimize Markdown ToC checker script