Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help page is incomplete #17021

Closed
jackharro opened this issue Apr 5, 2024 · 5 comments
Closed

Help page is incomplete #17021

jackharro opened this issue Apr 5, 2024 · 5 comments
Labels
Issue-Bug It either shouldn't be doing this or needs an investigation. Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting

Comments

@jackharro
Copy link

jackharro commented Apr 5, 2024

Windows Terminal version

1.19.10821.0

Windows build number

Microsoft Windows [Version 10.0.19045.4170]

Other Software

No response

Steps to reproduce

  1. Run commands such as wt -h, wt --help, wt /?
  2. Compare output with Microsoft Learn documentation: https://learn.microsoft.com/en-us/windows/terminal/command-line-arguments

Expected Behavior

All available options and commands are printed to a dialogue or to the terminal.

Actual Behavior

A selection of options and commands are printed to a dialogue. This means that information regarding options such as -d, the ; operator and the fact that you can call wt.exe followed by a command to run that command, are not included with each copy of Windows Terminal and the Microsoft Learn page must be referenced.

Windows Terminal Help
@jackharro jackharro added Issue-Bug It either shouldn't be doing this or needs an investigation. Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting labels Apr 5, 2024
Copy link

github-actions bot commented Apr 5, 2024

Hi I'm an AI powered bot that finds similar issues based off the issue title.

Please view the issues below to see if they solve your problem, and if the issue describes your problem please consider closing this one and thumbs upping the other issue to help us prioritize it. Thank you!

Closed similar issues:

Note: You can give me feedback by thumbs upping or thumbs downing this comment.

@jackharro
Copy link
Author

jackharro commented Apr 5, 2024

          So, each subcommands has context-specific options. Try `wt new-tab -h`!

^Originally posted by @DHowett-MSFT in #5560 (comment)
Windows Terminal new-tab Help

The subcommands have their own pages. For example, wt new-tab -h shows the -d option. The help pages are not incomplete, I just didn't use -h on subcommands which is standard practice and not a bug.

@DHowett
Copy link
Member

DHowett commented Apr 5, 2024

Thanks for following up! I wonder if there's a better way for us to surface these docs... 🤔

@zadjii-msft
Copy link
Member

Yea at the very least, #4134

@zadjii-msft
Copy link
Member

OR MAYBE A MARKDOWN DOCUMENT? 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Issue-Bug It either shouldn't be doing this or needs an investigation. Needs-Triage It's a new issue that the core contributor team needs to triage at the next triage meeting
Projects
None yet
Development

No branches or pull requests

3 participants