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

docs(cli): document codegen options in the CLI reference by abel05-droid · Pull Request #100 · pythonnative/pythonnative · GitHub

Repository navigation

docs(cli): document codegen options in the CLI reference - #100

Open
abel05-droid wants to merge 1 commit into
pythonnative:mainfrom
abel05-droid:docs-codegen-cli
Open

abel05-droid wants to merge 1 commit into
pythonnative:mainfrom
abel05-droid:docs-codegen-cli

Conversation

Copy link
Copy Markdown

What

  • Add pn codegen to the CLI subcommand reference.
  • Document --output, its default directory, and repeatable --module imports.
  • Add an explicit output-directory example and links to the native-contracts and generated-source documentation.

Why

pn codegen is available in the CLI but was missing from the hand-written subcommand reference.

How

Document the current pn codegen behavior and clarify that it generates contract files and prints their paths, while native compilation and app rebuilding happen in the build workflow.

Testing

  • Verified uv run pn codegen --help.
  • Ran uv run pn codegen --output /tmp/pythonnative-contracts and confirmed the generated files and printed paths.
  • Ran uv run --group docs mkdocs build --strict successfully.

Risks/Impact

Documentation-only change. No runtime behavior is modified.

Docs/Follow-ups

No follow-up changes required.

Closes #96

This branch has not been deployed

No deployments
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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document pn codegen in the CLI subcommand reference

1 participant


Back | FazBrowse Home | New Git URL