Develop

[Jamalludeen]

No description provided.

[Jamalludeen]

Issue #45 is covered

[Copilot]

Pull request overview

This PR polishes the port-scanner project’s developer/user-facing ergonomics by improving documentation/help text and making a small refactor to centralize scan timeout clamping.

Changes:

• Add a module docstring to the test runner and add type hints to CLI entrypoint functions.
• Document scan cancellation (Stop button) in both the README and in-app help dialog.
• Introduce a MIN_TIMEOUT constant and use it to clamp scan timeouts consistently.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
run_tests.py	Adds a top-level docstring describing the test runner wrapper.
README.md	Documents that long scans can be cancelled using Stop.
portscanner/scanner.py	Centralizes minimum timeout logic via MIN_TIMEOUT constant.
portscanner/gui.py	Updates the help dialog text to mention cancelling via Stop.
main.py	Adds return type hints to build_parser and main.

Comments suppressed due to low confidence (1)

portscanner/scanner.py:49

• The triple-quoted string inside PortScanner is not acting as a class docstring because it is placed after class attributes (MIN_TIMEOUT, etc.). This leaves an unused string literal in the class body and means PortScanner.__doc__ won’t reflect the intended documentation.

    MAX_PORTS_PER_SCAN = 4096
    # Keep accidental scans bounded so the GUI stays responsive.
    RANGE_LIMIT_MESSAGE = " Scan aborted: range exceeds {limit} ports.\n"

    """Controller for scanning port ranges with callbacks.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Jamalludeen]

Changes confirmed!