pnpm / pnpm.io

pnpm's website
https://pnpm.io
MIT License
211 stars 475 forks source link

clarify link example #533

Open Pascal-So opened 3 months ago

Pascal-So commented 3 months ago

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 🙂

stackblitz[bot] commented 3 months ago

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

vercel[bot] commented 3 months ago

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

A member of the Team first needs to authorize it.