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

yarn help list links to missing page #2718

Closed
justinbowes opened this issue Feb 17, 2017 · 3 comments
Closed

yarn help list links to missing page #2718

justinbowes opened this issue Feb 17, 2017 · 3 comments
Labels

Comments

@justinbowes
Copy link

Do you want to request a feature or report a bug?

  • bug

What is the current behavior?
yarn help list returns a link to online documentation:

  --network-concurrency <number>  maximum number of concurrent network requests
    --depth [depth]                 Limit the depth of the shown dependencies

  Visit https://yarnpkg.com/en/docs/cli/list for documentation about this command.

However, visiting https://yarnpkg.com/en/docs/cli/list results in a 404.

If the current behavior is a bug, please provide the steps to reproduce.

yarn help list

What is the expected behavior?
The URL returned by yarn help list should document the command.

Please mention your node.js, yarn and operating system version.
v6.9.5; 0.20.3; Mac OS X 10.11.6

@SgtPooki
Copy link

SgtPooki commented Feb 18, 2017

It looks like the standard is to use the actual command name for the URL, but someone incorrectly set the URL for list as ls: https://yarnpkg.com/en/docs/cli/ls

But you can see from the following aliases, that the urls are not consistent:

yarn/src/cli/aliases.js

Lines 4 to 17 in efa1c7a

c: 'config',
i: 'install',
la: 'list',
ll: 'list',
ln: 'link',
ls: 'list',
r: 'remove',
rb: 'rebuild',
rm: 'remove',
t: 'test',
tst: 'test',
un: 'remove',
up: 'upgrade',
v: 'version',

From the few highlighted shorthand items above:

Correct 404s (shorthand):

Incorrect 200s (shorthand):

Incorrect 404s (non-shorthands):

Correct 200s (non-shorthands):

Missing documentation urls:

@sergio-rojasa
Copy link

I would like to work on this

@gsklee
Copy link
Contributor

gsklee commented May 22, 2017

@bestander close

The situation has been resolved with the removal of aliases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants