Skip to content

Samples for #148 - #156

Merged
kujirahand merged 6 commits into
mainfrom
samples_for_148
Apr 20, 2026
Merged

kujirahand merged 6 commits into
mainfrom
samples_for_148

Conversation

@kujirahand

Copy link
Copy Markdown
Owner

This pull request improves the documentation and usability of the popup_get_file dialog 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:

  • Expanded the docstring for popup_get_file in TkEasyGUI/dialogs.py to include detailed usage instructions, parameter explanations, and multiple code examples for opening, saving, and selecting multiple files, as well as filtering by file type.
  • Updated the API documentation in docs/TkEasyGUI/dialogs-py.md to reflect the enhanced popup_get_file documentation, including new usage examples and clearer parameter descriptions. [1] [2]

README Enhancements:

  • Added an icon image and a new code example for the file selection dialog in README.md, showcasing how to use popup_get_file and displaying the result. [1] [2]
  • Improved installation instructions in the README.md to clarify usage of pip from both PyPI and GitHub, and added steps for cloning and installing from source. [1] [2]

General Documentation Maintenance:

  • Updated line references for function documentation in docs/TkEasyGUI/dialogs-py.md to match their new locations in the source code, ensuring accuracy and consistency.

Copilot AI review requested due to automatic review settings April 20, 2026 05:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_file docstring with usage notes and multiple examples.
  • Updated generated API docs (docs/TkEasyGUI/dialogs-py.md) including refreshed source links and new popup_get_file documentation.
  • Added/updated README content (icon placement, install instructions, and a popup_get_file example) and added a new sample script under tests/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.

Comment thread docs/TkEasyGUI/dialogs-py.md
Comment thread docs/TkEasyGUI/dialogs-py.md Outdated
Comment thread docs/TkEasyGUI/dialogs-py.md Outdated
Comment thread TkEasyGUI/dialogs.py
kujirahand and others added 4 commits April 20, 2026 14:37
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>
@kujirahand
kujirahand merged commit e51f393 into main Apr 20, 2026
@kujirahand
kujirahand deleted the samples_for_148 branch April 20, 2026 05:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants