Noticed an inconsistency in the Planner documentation. Option sets --planId, --planName and --ownerGroupId, --ownerGroupName are used in almost every Planner command.
Discussed in #3336 (comment), we noticed that in some Planner commands it's not specified when an option should be used.
--planId & --planName should be used when task name or bucket name is specified.
--ownerGroupId & --ownerGroupName should only be used when the name of a plan is specified.
In brief, the last sentence of the option description should be changed from
Specify ownerGroupId or ownerGroupName but not both.
to
Specify ownerGroupId or ownerGroupName when using planName.
Command docs to update
| Command |
Option descriptions to update |
| planner bucket set |
planId, planName, ownerGroupId, ownerGroupName |
| planner plan details get |
ownerGroupId, ownerGroupName |
| planner plan get |
ownerGroupId, ownerGroupName |
| planner task set |
bucketId, bucketName |
Noticed an inconsistency in the Planner documentation. Option sets
--planId,--planNameand--ownerGroupId,--ownerGroupNameare used in almost every Planner command.Discussed in #3336 (comment), we noticed that in some Planner commands it's not specified when an option should be used.
--planId&--planNameshould be used when task name or bucket name is specified.--ownerGroupId&--ownerGroupNameshould only be used when the name of a plan is specified.In brief, the last sentence of the option description should be changed from
Specify
ownerGroupIdorownerGroupNamebut not both.to
Specify
ownerGroupIdorownerGroupNamewhen usingplanName.Command docs to update
planId,planName,ownerGroupId,ownerGroupNameownerGroupId,ownerGroupNameownerGroupId,ownerGroupNamebucketId,bucketName