Skip to content

README names each option's flag; three docstrings say what the code does - #1

Merged
loggger101 merged 1 commit into
mainfrom
docs-flags-and-docstrings
Oct 20, 2026
Merged

loggger101 merged 1 commit into
mainfrom
docs-flags-and-docstrings

Conversation

@loggger101

Copy link
Copy Markdown
Owner

Documentation only; no code changes.

README

  • The options table gains a flag column: --hint, --port and --no-install do not match the LaunchConfig fields they set.
  • requirements says what it falls back to (streamlit>=1.30) when the file is missing, and that it resolves against workdir.
  • The intro states the Python 3.9 floor and that CI runs Windows, Linux and macOS; a CI badge.
  • Develop mentions tests/test_rules.py and the release steps (bump __version__, CHANGELOG entry, tag).

launcher.py docstrings

  • _done_booting: the button is "Open dashboard", not "Open in browser".
  • quit: setting stopping stops the pump rescheduling (it said clearing).
  • _port_answers: says why it is asked before _port_is_free (a 0.0.0.0 listener does not stop a 127.0.0.1 bind on Windows) instead of repeating the SO_REUSEADDR note.

python -m pytest: 48 passed locally (Windows, Python 3.14).

🤖 Generated with Claude Code

README: the options table gains a flag column, since `--hint`, `--port`
and `--no-install` do not match the fields they set; `requirements` says
what it falls back to; the intro states the Python 3.9 floor and the three
CI platforms; a CI badge; Develop gains the rules test and the release
steps from CLAUDE.md.

launcher.py docstrings: `_done_booting` names the "Open dashboard" button
(it said "Open in browser"), `quit` says setting `stopping` (it said
clearing), and `_port_answers` says why it is asked first instead of
repeating `_port_is_free`'s SO_REUSEADDR note. No code changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@loggger101
loggger101 merged commit 90838e6 into main Oct 20, 2026
9 checks passed
@loggger101
loggger101 deleted the docs-flags-and-docstrings branch October 20, 2026 20:54
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.

1 participant