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

docs/cli: Added test command docs. #136

Merged
merged 1 commit into from
Oct 12, 2016
Merged

Conversation

umamialex
Copy link
Contributor

@umamialex umamialex commented Oct 12, 2016

The documentation for the test command was missing so I decided to add it in with the first commit.

In the second commit, I added more information about system-wide commands not being executable by Yarn. Since it's possibly a breaking change for people coming from npm, I felt it should be proactively addressed in the docs.

The third commit just adds a missing p.lead tag to run.

I tried to lift the wording and formatting from other doc entries.

@umamialex umamialex force-pushed the docs-cli-test branch 3 times, most recently from 0650d7c to be9151d Compare October 12, 2016 05:26
@cpojer
Copy link
Contributor

cpojer commented Oct 12, 2016

Would you mind reverting the changes to yarn run? That seems to me like a bug we should fix in yarn. Let's keep this PR focused on yarn test.

@addyosmani
Copy link
Member

Let's keep this PR focused on yarn test.

👍

Copy link
Member

@addyosmani addyosmani left a comment

Choose a reason for hiding this comment

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

Initial docs lgtm. I'll let @thejameskyle decide if there's any more he'd like improved there.

@umamialex umamialex changed the title docs/cli: Added test command docs and updated run docs. docs/cli: Added test command docs. Oct 12, 2016
@umamialex
Copy link
Contributor Author

Removed both the changes to run docs and mention of the inability to run system commands. Looks like that issue was found and fixed in yarnpkg/yarn#733.

@cpojer cpojer merged commit 07e09a4 into yarnpkg:master Oct 12, 2016
@cpojer
Copy link
Contributor

cpojer commented Oct 12, 2016

thank you!

@umamialex umamialex deleted the docs-cli-test branch October 13, 2016 00:44
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.

3 participants