Skip to content
This repository was archived by the owner on Sep 5, 2024. It is now read-only.

docs(contact-chips): improve the comments about highlighting #11362

Merged
merged 1 commit into from
Jul 11, 2018
Merged

docs(contact-chips): improve the comments about highlighting #11362

merged 1 commit into from
Jul 11, 2018

Conversation

Splaktar
Copy link
Contributor

@Splaktar Splaktar commented Jul 8, 2018

PR Checklist

Please check that your PR fulfills the following requirements:

  • The commit message follows our guidelines
  • Tests for the changes have been added or this is not a bug fix / enhancement
  • Docs have been added, updated, or were not required

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Enhancement
[x] Documentation content changes
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Infrastructure changes
[ ] Other... Please describe:

What is the current behavior?

Using md-highlight-text on contact chips actually breaks the component, but the docs recommend doing this.
Only md-highlight-flags is supported on contact chips, but it isn't mentioned in the docs.

Issue Number:
Relates to #8142

What is the new behavior?

Docs no longer suggest to use md-highlight-text with contact chips.
They do suggest that you can use md-highlight-flags with contact chips.
Added md-highlight-flags example to mdHighlightDirective docs.

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@Splaktar
docs(contact-chips): improve the comments about highlighting
4e84321 
using md-highlight-text on contact chips actually breaks the component
only md-highlight-flags is supported on contact chips
add md-highlight-flags example to mdHighlightDirective docs

Relates to #8142
@Splaktar Splaktar added type: docs pr: merge ready This PR is ready for a caretaker to review P5: nice to have These issues will not be fixed without community contributions. pr: merge safe labels Jul 8, 2018
@Splaktar Splaktar added this to the 1.1.11 milestone Jul 8, 2018
@googlebot googlebot added the cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ label Jul 8, 2018
jelbourn
jelbourn approved these changes Jul 11, 2018
View reviewed changes
Copy link
Member

@jelbourn jelbourn left a comment

Choose a reason for hiding this comment

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

LGTM

@jelbourn jelbourn merged commit 6972119 into master Jul 11, 2018
@Splaktar Splaktar deleted the chipsHighlightDocs branch July 11, 2018 18:51
Splaktar added a commit that referenced this pull request Jul 31, 2018
@Splaktar
docs(contact-chips): improve the comments about highlighting (#11362)
7159787 
using md-highlight-text on contact chips actually breaks the component
only md-highlight-flags is supported on contact chips
add md-highlight-flags example to mdHighlightDirective docs

Relates to #8142
Splaktar added a commit that referenced this pull request Aug 2, 2018
@Splaktar
docs(contact-chips): improve the comments about highlighting (#11362)
9099c1b 
using md-highlight-text on contact chips actually breaks the component
only md-highlight-flags is supported on contact chips
add md-highlight-flags example to mdHighlightDirective docs

Relates to #8142
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers
1 more reviewer

@jelbourn jelbourn jelbourn approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@jelbourn jelbourn

Labels
cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ P5: nice to have These issues will not be fixed without community contributions. pr: merge ready This PR is ready for a caretaker to review type: docs
Projects
None yet
Milestone
1.1.11
Development

Successfully merging this pull request may close these issues.
3 participants
@Splaktar @jelbourn @googlebot