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

docs(select): clarify behavior of multiple attribute #11316

Merged
merged 1 commit into from
Jun 22, 2018

Conversation

Splaktar
Copy link
Member

@Splaktar Splaktar commented Jun 6, 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?

The docs are misleading and cause developers to think that something like multiple="ctrl.isMultiple" can be used. In fact, only the existence of the attribute matters. This follows a common pattern used in AngularJS Material APIs.

Issue Number:
Closes #3068

What is the new behavior?

  • Align the multiple docs with the actual behavior of the API
  • fix syntax ordering error with md-no-asterisk docs
  • remove instances of multiple="multiple" from tests
  • update test to check for non-existence of multiple rather than value
  • add test to check for existence of multiple

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

fix syntax ordering error with `md-no-asterisk` docs
remove instances of `multiple="multiple"` from tests
update test to check for non-existence of multiple rather than value
add test to check for existence of multiple

Closes #3068
@googlebot googlebot added the cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ label Jun 6, 2018
@Splaktar Splaktar added this to the 1.1.10 milestone Jun 6, 2018
@Splaktar Splaktar added type: docs P4: minor Minor issues. May not be fixed without community contributions. labels Jun 6, 2018
@Splaktar Splaktar added pr: merge ready This PR is ready for a caretaker to review pr: merge safe labels Jun 6, 2018
@Splaktar Splaktar assigned jelbourn and unassigned andrewseguin Jun 10, 2018
@jelbourn jelbourn merged commit a6bca73 into master Jun 22, 2018
@Splaktar Splaktar deleted the fixSelectMultipleDocs branch June 22, 2018 20:58
Splaktar added a commit that referenced this pull request Jul 31, 2018
fix syntax ordering error with `md-no-asterisk` docs
remove instances of `multiple="multiple"` from tests
update test to check for non-existence of multiple rather than value
add test to check for existence of multiple

Closes #3068
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
cla: yes PR author has signed Google's CLA: https://opensource.google.com/docs/cla/ P4: minor Minor issues. May not be fixed without community contributions. pr: merge ready This PR is ready for a caretaker to review type: docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

select: multiple attribute only checks for existence but docs indicate that it evaluates true/false
4 participants