[Link] Improve docblocks and readme for links #2153
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Make it clear external is to be used for an page that opens in a new tab Make wording and ordering consistent between Link and UnstyledLink
kaelig
reviewed
Sep 17, 2019
BPScott
force-pushed
the
link-details
branch
from
e7dc675 to
bd34507
Compare
kaelig
previously requested changes
Sep 17, 2019
Contributor
kaelig
left a comment
kaelig
left a comment
There was a problem hiding this comment.
Looks like this PR's scope has gone beyond docblocks.
Can you update the title to reflect the new scope, and prefix it with the component's name?
Also, I'd say it's worth having a CHANGELOG entry for this.
BPScott
changed the title
selenehinkley
approved these changes
Sep 18, 2019
Contributor
selenehinkley
left a comment
selenehinkley
left a comment
There was a problem hiding this comment.
The copy looks good to me! Thanks for making this update, Ben!
BPScott
force-pushed
the
link-details
branch
from
bd34507 to
ed5b57f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
People are unclear if the
externalprop on links should be used for sites external to shopify, or anything that opens in a new tab.You should use it for anything that opens in a new tab.
WHAT is this pull request doing?
Make it clear external is to be used for an page that opens in a new tab
Make wording and ordering consistent between Link and UnstyledLink
Clarify readme to make it clear the important thing is "you're going anywhere in a new tab", not "you're going outside your current domain"