Repository navigation
docs: add docs/scripts.md index of the 13 scripts and link it from README - #31
Merged
Merged
Conversation
…ADME scripts/ now holds 13 runnable files and is growing, but there was no way to tell what any of them do without opening each one. Some names are also cryptic (check.py, toh.py, argparse_1.py). - Add docs/scripts.md: a table with every current file, a one-line description written from actually running / reading the script, and how to run it (including the pip install needed for pdf2doc and qr_code_generator). - Update the README "Runnable scripts" bullet to link to the index instead of pointing at issue utk2103#15 as "up for grabs". All 13 files in scripts/ have a row; no source files renamed. Closes utk2103#15
utk2103
approved these changes
Oct 12, 2026
Owner
|
thanks for the pr @wufangyong973 !! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
What changed
scripts/now holds 13 runnable files and is growing, but there was no way to tell what any of them do without opening each one. Some names are also cryptic (check.py,toh.py,argparse_1.py).Adds
docs/scripts.md— a table with a row for every current file: what it does (written from actually running or reading the script, not guessed from the filename) and how to run it, including thepip installneeded for the two scripts that use external packages (pdf2docx,qrcode[pil]).Updates the README's "Runnable scripts" bullet to link to the index instead of pointing at the now-resolved issue #15 as "up for grabs".
Acceptance criteria
scripts/has a row — 13 rows, no blanks.BinarySearch.py,LinearSearch.py,MergeSort.py,enum_use_case.pyto confirm; read the rest).docs/scripts.md.Closes #15