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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarify link example #533

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

clarify link example #533

wants to merge 1 commit into from

Conversation

Pascal-So
Copy link

I switched the example to be about the link <dir> case instead of the link --dir <dir> case, and made the text more readable.

Other examples in the same doc page use foo as the dependent and bar as the dependency, therefore it's easier to understand the example if that convention is kept.

Also, the case without --dir seems to be the "basic case" that is used more often, so for a beginner who's first reading about all of this it makes more sense to introduce that one first. The title of the section also suggests that we're primarily talking about the case without --dir.

When I first read the documentation, I misread the command and didn't notice the --dir argument, and then misunderstood how the command works, i.e. I first thought the roles of the packages would be reversed to what they actually are.

I hope you find the updated example clearer as well, and if not feel free to close 馃檪

Copy link

stackblitz bot commented May 11, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

vercel bot commented May 11, 2024

@Pascal-So is attempting to deploy a commit to the pnpm Team on Vercel.

A member of the Team first needs to authorize it.

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.

None yet

1 participant