Repository navigation
docs(submit): clarify that --prtitle and --token are optional - #707
Open
Reginald Alfret V (reginaldalfret) wants to merge 1 commit into
Open
Reginald Alfret V (reginaldalfret) wants to merge 1 commit into
Reginald Alfret V (reginaldalfret) wants to merge 1 commit into
Conversation
Signed-off-by: reginaldalfret <reginaldalfret@gmail.com>
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
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
1 participant
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.
Summary
Clarify that
--prtitleand--tokenare optional arguments indoc/submit.md.Description
In
doc/submit.md, the usage example previously showedwingetcreate.exe submit --prtitle <PullRequestTitle> --token <GitHubPersonalAccessToken> <PathToManifest>without brackets, which could imply to contributors that--prtitleis mandatory. In reality,SubmitCommandhasPRTitleas optional (Required = false) and automatically generates a title from the manifest package identifier and version when omitted.This PR:
[--prtitle <PullRequestTitle>]and[--token <GitHubPersonalAccessToken>]in square brackets in the Usage example to denote optional arguments (consistent withupdate.md).-p, --prtitleis optional and automatically generated when omitted.Related Issue
Fixes #705
Microsoft Reviewers: Open in CodeFlow