Fix script names in usage comments #147
Merged
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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the usage examples in three markdown generator scripts to reference their current filenames.
- Replace outdated
examples_to_markdown*.pynames with the actual script names. - Align usage comments across
.scripts/gen_single_markdown.py,.scripts/gen_markdown_pages.py, and.scripts/gen_markdown_chapters.py.
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| .scripts/gen_single_markdown.py | Updated usage comment to gen_single_markdown.py |
| .scripts/gen_markdown_pages.py | Updated usage comment to gen_markdown_pages.py |
| .scripts/gen_markdown_chapters.py | Updated usage comment to gen_markdown_chapters.py |
Comments suppressed due to low confidence (1)
.scripts/gen_single_markdown.py:4
- [nitpick] Consider using a single colon in the Usage header to match the other scripts' docstrings (e.g.,
Usage:) for consistency.
Usage::
❌ Deploy Preview for tutorial-python failed. Why did it fail? →
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Testing
pytest -qpython -m py_compile .scripts/gen_markdown_chapters.py .scripts/gen_markdown_pages.py .scripts/gen_single_markdown.pyhttps://chatgpt.com/codex/tasks/task_e_6850526e5b988324b42912b4fa97808b