FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Package overview docs reference a stale `page` module and an incomplete CLI list · Issue #45 · pythonnative/pythonnative · GitHub

Package overview docs reference a stale page module and an incomplete CLI list #45

Description

Problem

Two stale spots in docs/api/pythonnative.md:

  • Line 6 lists page among the deeper internals, but that module was renamed long ago; the codebase only has src/pythonnative/screen.py (documented at docs/api/screen.md).
  • The CLI row of the module table (line 61) lists only pn init, pn run, pn clean, while the CLI also ships preview, doctor, devices, logs, build, app-id, and --version (see the subparsers in src/pythonnative/cli/pn.py).

Suggested fix

  • Replace page with screen on line 6.
  • Update the CLI row to cover the current command set, or trim it to a few highlights with a "and more" link to the CLI reference so it doesn't go stale again.
  • While there, skim the rest of the page for other outdated names.

Verification

Run mkdocs build --strict.

Suggested commit message

docs(mkdocs): refresh package overview internals and CLI lists

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


    Back | FazBrowse Home | New Git URL