Samples for #148 - #156
Merged
Merged
Samples for #148#156
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances TkEasyGUI’s popup_get_file documentation and examples to improve discoverability and usability, and updates the README installation and usage guidance accordingly.
Changes:
- Expanded
popup_get_filedocstring with usage notes and multiple examples. - Updated generated API docs (
docs/TkEasyGUI/dialogs-py.md) including refreshed source links and newpopup_get_filedocumentation. - Added/updated README content (icon placement, install instructions, and a
popup_get_fileexample) and added a new sample script undertests/popup/.
Reviewed changes
Copilot reviewed 4 out of 6 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
TkEasyGUI/dialogs.py |
Expands the popup_get_file docstring with detailed usage notes and examples. |
docs/TkEasyGUI/dialogs-py.md |
Updates the API docs for popup_get_file and refreshes source links/formatting. |
README.md |
Adds an icon near the top, improves install instructions, and adds a file dialog example + screenshot. |
tests/popup/popup_get_file.py |
Adds a runnable sample demonstrating single and multiple file selection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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
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.
This pull request improves the documentation and usability of the
popup_get_filedialog in the TkEasyGUI library, and enhances the overall clarity of the README and API documentation. The main changes include expanded usage examples and parameter explanations for file dialogs, updates to installation instructions, and alignment of documentation with recent code changes.Documentation and Example Improvements:
popup_get_fileinTkEasyGUI/dialogs.pyto include detailed usage instructions, parameter explanations, and multiple code examples for opening, saving, and selecting multiple files, as well as filtering by file type.docs/TkEasyGUI/dialogs-py.mdto reflect the enhancedpopup_get_filedocumentation, including new usage examples and clearer parameter descriptions. [1] [2]README Enhancements:
README.md, showcasing how to usepopup_get_fileand displaying the result. [1] [2]README.mdto clarify usage of pip from both PyPI and GitHub, and added steps for cloning and installing from source. [1] [2]General Documentation Maintenance:
docs/TkEasyGUI/dialogs-py.mdto match their new locations in the source code, ensuring accuracy and consistency.