docs(cli): add help text for positional platform arguments - #81
Open
glenlouis8 wants to merge 1 commit into
Open
docs(cli): add help text for positional platform arguments#81glenlouis8 wants to merge 1 commit into
glenlouis8 wants to merge 1 commit into
Conversation
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
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
help="Target platform"to the required positionalplatformargument onpn run,pn logs,pn build, andpn app-id.Why
pn <cmd> --helplisted{android,ios}under "positional arguments" with no description, while every flag on the same subcommand is described.doctoranddevicesalready describe theirplatformargument; these four did not.How (brief)
add_argument("platform", ...)call in_build_parser()insrc/pythonnative/cli/pn.py. Wording kept identical across the four and consistent with the existingdoctor/devicesstrings.--helpoutput tests (test_cli_run_help_lists_flags,test_cli_build_help_lists_debug) intests/test_cli.pyto assert the new text appears.Testing
Risks/Impact
Docs/Follow-ups
Closes #55