Skip to content
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.

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

[docs] : Update Pergerine docs related to Items component #1020

Merged
merged 2 commits into from
Mar 21, 2019

Conversation

ronak2ram
Copy link
Member

@ronak2ram ronak2ram commented Mar 13, 2019

Description

Not a bug, but an incorrect piece of info on the devdocs relating to the Items component of the peregrine library. On this page it says "check" as an option for selectionModel props and is used in the example code. However, the Items class's propTypes specify that the selectionModel property is either 'checkbox' or 'radio'. Using 'check' here would cause an error.

Related Issue

Closes: #1007

Motivation and Context

Fixes a bug in documentation.

Verification

Verify that peregrine/List/items.js accepts a selectionModel prop that accepts a value "checkbox" and not "check".

How Has This Been Tested?

Screenshots (if appropriate):

Proposed Labels for Change Type/Package

DOCUMENTATION

pwa-devdocs

Checklist:

  • I have read the CONTRIBUTING document.
  • I have linked an issue to this PR.
  • I have indicated the change type and relevant package(s).
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • All CI checks are green (linting, build/deploy, etc).
  • At least one core contributor has approved this PR.

@vercel
Copy link

vercel bot commented Mar 13, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

@ronak2ram ronak2ram changed the title Update Pergerine docs related to Items component Bugfix : Update Pergerine docs related to Items component Mar 13, 2019
@ronak2ram ronak2ram changed the title Bugfix : Update Pergerine docs related to Items component [BUG] : Update Pergerine docs related to Items component Mar 13, 2019
@coveralls
Copy link

coveralls commented Mar 13, 2019

Coverage Status

Coverage remained the same at 76.901% when pulling dbf86db on ronak2ram:update-pergerine into c7a8b32 on magento-research:develop.

@sirugh sirugh changed the title [BUG] : Update Pergerine docs related to Items component [docs] : Update Pergerine docs related to Items component Mar 21, 2019
@sirugh sirugh added the documentation This pertains to documentation. label Mar 21, 2019
Copy link
Contributor

@supernova-at supernova-at left a comment

Choose a reason for hiding this comment

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

Thanks!

@jcalcaben this doc isn't part of the auto-generation, is it?

@supernova-at supernova-at merged commit 68cab97 into magento:develop Mar 21, 2019
@sirugh sirugh added the version: Patch This changeset includes backwards compatible bug fixes. label May 24, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This pertains to documentation. version: Patch This changeset includes backwards compatible bug fixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update Pergerine docs related to Items component
5 participants