Some quality-of-life enhancements to toc.py CLI script #329
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
Add proper error handling, logging, command-line options, and improved documentation. Clean anchor generation, add version, and enhance CLI help text with better descriptions and examples.
edoardob90
added
documentation
Replace f-strings with %-style formatting in logger calls for better performance. Use logger.exception() for better error reporting with tracebacks.
|
There is also: #131. Should that one be closed? |
Done, closed. We can track all the relevant changes here. |
Upgrade TocEntry from namedtuple to NamedTuple with type hints. Improve logic for detecting and ignoring markdown headers inside code blocks to prevent incorrect TOC entries. Also refactor the file output handling for better organization when using --force.
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.
Hopefully closes #240.
Add proper error handling, logging, command-line options, and improved documentation. Clean anchor generation, add version, and enhance CLI help text.