Closed Bug 815342 Opened 12 years ago Closed 12 years ago

GCLI commands with optional options have misleading synopsis

Categories

(DevTools Graveyard :: Graphic Commandline and Toolbar, defect)

18 Branch
defect
Not set
normal

Tracking

(Not tracked)

RESOLVED DUPLICATE of bug 799769

People

(Reporter: tw2113, Unassigned)

Details

User Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7; rv:18.0) Gecko/18.0 Firefox/18.0 Build ID: 20121119042013 Steps to reproduce: Ran the screenshot command via the Developer Toolbar Actual results: Synopsis information is not uptodate with current method of adding parameters. Expected results: New --flag style should have been shown instead of "screenshot false true 0" etc
Component: Untriaged → Developer Tools
Michael, could you please attach the file you used screenshot with to this bug report? We need to reproduce the bug in order to cofirm it, and I couldn't reproduce it with Firefox 18 or 20 until now.
Flags: needinfo?(tw2113)
Michael is referring to typing the --arguments, which aren't immediately obvious in gcli. For example, writing 'screenshot file' would show an [options] placeholder, which signals that extra arguments can be added, but there's no way of discovering that typing -- is required to display them. This bug affects all commands that use this variable-number-of-arguments pattern. CCing Joe.
Flags: needinfo?(tw2113)
OS: Mac OS X → All
Hardware: x86 → All
Thanks for the details, Victor. Reproducible on the latest Nightly too (11/26).
Status: UNCONFIRMED → NEW
Ever confirmed: true
Changing the summary of the bug to reflect a general use case
Summary: Devtools screenshot help Synopsis needs updated to new syntax → Commands with optional options have misleading synopsis in the "help <command>" popup
Agreed. There is an extenuating circumstance here in that Kevin's video highlights the old way. Also it could be argued that using '-' (you only need one) is common-place in command lines. However that's not to say that we shouldn't improve things, and it's something I'll bear in mind. Thanks for the report.
Summary: Commands with optional options have misleading synopsis in the "help <command>" popup → GCLI commands with optional options have misleading synopsis
Still need anything from me? or are we good to go?
(In reply to Michael Beckwith from comment #6) > Still need anything from me? or are we good to go? I think we understand the problem, thanks.
New component triage. Filter on "Lobster Thermidor aux crevettes with a Mornay sauce"
Component: Developer Tools → Developer Tools: Graphic Commandline and Toolbar
Status: NEW → RESOLVED
Closed: 12 years ago
Resolution: --- → DUPLICATE
Product: Firefox → DevTools
Product: DevTools → DevTools Graveyard
You need to log in before you can comment on or make changes to this bug.