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: README in @carbon/pictograms-react has incorrect usage information #4314

Closed
2 tasks done
metonym opened this issue Oct 12, 2019 · 0 comments · Fixed by #4317
Closed
2 tasks done

docs: README in @carbon/pictograms-react has incorrect usage information #4314

metonym opened this issue Oct 12, 2019 · 0 comments · Fixed by #4317

Comments

@metonym
Copy link
Collaborator

metonym commented Oct 12, 2019

What package(s) are you using?

  • carbon-components
  • carbon-components-react

Detailed description

The README for carbon/packages/pictograms-react contains incorrect usage information.

The usage section reads:

import { Add24 } from '@carbon/pictograms-react';

However, there is no Add24 export from pictograms.

Additionally, the Usage footnote links to the icon library in the Carbon Design System docs.

Note: if you would like to find the import path for an icon, you can reference our Icon Library

Proposed changes

  1. Use a valid example in the Usage section
  2. Link to the pictograms documentation in Carbon
- import { Add24 } from '@carbon/pictograms-react';
+ import { Airplane } from '@carbon/pictograms-react';
- Note: if you would like to find the import path for an icon, you can reference our [Icon Library](https://www.carbondesignsystem.com/guidelines/icons/library/)
+ Note: if you would like to find the import path for a pictogram, you can reference our [Pictogram Library](https://www.carbondesignsystem.com/guidelines/pictograms/library)

Additional information

Once the README is updated, the package should be patched so that the changes are propagated to the npm/yarn registries.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants