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

Update the documentation for the ls command for the rename to list. #277

Closed
wants to merge 1 commit into from

Conversation

danielmcgraw
Copy link

Update to the documentation if/when yarnpkg/yarn#1940 is pulled in to yarn.

Copy link
Member

@Daniel15 Daniel15 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like there's a merge conflict, could you please rebase?

Additionally, please add a redirect from the old URL to the new one. You can add the redirect into the _redirects file at the root.

@danielmcgraw
Copy link
Author

@Daniel15 Fixed that up. Thanks for letting me know.

Copy link

@charlierudolph charlierudolph left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @danielmcgraw. I accidentally created a PR for the same thing and just commented on some changes my PR had that yours doesn't.

@Daniel15 anything stopping this from being merged?

tags: ["cli-ls"]
- id: docs_cli_list
path: /docs/cli/list
tags: ["cli-list"]
Copy link

@charlierudolph charlierudolph Dec 23, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should reordered to be above login, logout in order to keep the commands in alpha order

@@ -125,7 +125,7 @@ docs_cli_licenses: yarn licenses
docs_cli_link: yarn link
docs_cli_login: yarn login
docs_cli_logout: yarn logout
docs_cli_ls: yarn ls
docs_cli_list: yarn list

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be moved above login / logout to retain alpha order.

@namhong2001
Copy link

namhong2001 commented Dec 28, 2016

I also encountered mismatch between docs and yarn ls errors. I hope this will be merged soon.

@@ -10,7 +10,7 @@ layout: guide

##### `yarn global` <a class="toc" id="toc-yarn-global" href="#toc-yarn-global"></a>

`yarn global` is a prefix used for a number of commands like `add`, `bin`, `ls` and `remove`. They behave identically to their normal versions except that they use a global directory to store packages. The `global` command makes binaries available to use on your operating system.
`yarn global` is a prefix used for a number of commands like `add`, `bin`, `list` and `remove`. They behave identically to their normal versions except that they use a global directory to store packages. The `global` command makes binaries available to use on your operating system.
Copy link

@namhong2001 namhong2001 Dec 28, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yarn global list is not valid yet. yarn global ls command remained. v0.18.1
I added an issue to yarn yarn#2354

@gsklee
Copy link
Contributor

gsklee commented Jan 11, 2017

If changes haven't gone live then the docs shouldn't be modified ahead of it. Right now the docs is in need of some adjustment to make it look right: https://yarnpkg.com/en/docs/cli/ls

markstos added a commit to markstos/website that referenced this pull request Feb 27, 2017
 - yarnpkg#356 did not create redirect
 - yarnpkg#334 duplicated some work already done in yarnpkg#333 also did not update
   all necessary files.
 - yarnpkg#277 had merge conflicts that went unaddressed.

Once this is merged, all of yarnpkg#277, yarnpkg#334 and yarnpkg#356 can be closed.
markstos added a commit to markstos/website that referenced this pull request May 19, 2017
 - yarnpkg#356 did not create redirect
 - yarnpkg#334 duplicated some work already done in yarnpkg#333 also did not update
   all necessary files.
 - yarnpkg#277 had merge conflicts that went unaddressed.

Once this is merged, all of yarnpkg#277, yarnpkg#334 and yarnpkg#356 can be closed.
bestander pushed a commit that referenced this pull request May 19, 2017
- #356 did not create redirect
 - #334 duplicated some work already done in #333 also did not update
   all necessary files.
 - #277 had merge conflicts that went unaddressed.

Once this is merged, all of #277, #334 and #356 can be closed.
@Haroenv
Copy link
Member

Haroenv commented May 22, 2017

Thanks for helping. If I see this correctly, this has been fixed by #377

@Haroenv Haroenv closed this May 22, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants