Skip to content

docs(chips): remove example from component jsdoc #6888

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Sep 15, 2017
Merged

docs(chips): remove example from component jsdoc #6888

merged 2 commits into from
Sep 15, 2017

Conversation

andrewseguin
Copy link
Contributor

@andrewseguin andrewseguin commented Sep 6, 2017 •
edited
Loading

Closes #6885

@googlebot googlebot added the cla: yes PR author has agreed to Google's Contributor License Agreement label Sep 6, 2017
@willshowell
Copy link
Contributor

Does it even make sense to have an example in the class comment? A nearly identical example is near the top of the overview.

https://material.angular.io/components/chips/overview

@andrewseguin
Copy link
Contributor Author

It is rather redundant, I'm okay with removing it. What do you think @jelbourn - I don't think we include basic examples in other components

@jelbourn
Copy link
Member

jelbourn commented Sep 6, 2017

Yeah, we shouldn't have examples in the descriptions. Live examples are always better because we actually build them.

@andrewseguin andrewseguin changed the title docs(chips): close md-chip tag docs(chips): remove example from component jsdoc Sep 7, 2017
@andrewseguin
Copy link
Contributor Author

SGTM - removed the example altogether

tinayuangao
tinayuangao approved these changes Sep 12, 2017
View reviewed changes
Copy link
Contributor

@tinayuangao tinayuangao 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 approved these changes Sep 13, 2017
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 added pr: lgtm action: merge The PR is ready for merge by the caretaker and removed pr: needs review labels Sep 13, 2017
@mmalerba mmalerba merged commit 2730fe0 into angular:master Sep 15, 2017
josephperrott pushed a commit to josephperrott/components that referenced this pull request Sep 15, 2017
@andrewseguin @josephperrott
docs(chips): remove example from component jsdoc (angular#6888)
9461127 
* docs(chips): close md-chip tag

* remove example
@andrewseguin andrewseguin deleted the chips-docs-fix branch November 28, 2017 20:40
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Sep 7, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jelbourn jelbourn jelbourn approved these changes

@tinayuangao tinayuangao tinayuangao approved these changes

Assignees
No one assigned
Labels
action: merge The PR is ready for merge by the caretaker cla: yes PR author has agreed to Google's Contributor License Agreement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

HTML error in Chips documentation
6 participants
@andrewseguin @willshowell @jelbourn @tinayuangao @googlebot @mmalerba