Skip to content

Commit

Permalink
docs: Fix typos (#1111)
Browse files Browse the repository at this point in the history
  • Loading branch information
silvalaura authored Jul 12, 2023
1 parent 102e4fe commit 318a2f1
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 13 deletions.
5 changes: 5 additions & 0 deletions .changeset/docs-typos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'react-magma-docs': patch
---

Update typos
4 changes: 2 additions & 2 deletions website/react-magma-docs/src/pages/design/alert.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Indicates that a system process completed successfully.

### Warning

Indicates that something isn't quite right, but there wasn't an error.
Indicates that something is not quite right, but there wasn't an error.

<Alert variant="warning">Umm, something's not quite right here.</Alert>

Expand All @@ -106,7 +106,7 @@ Inline alerts are embedded within the content of a page. They can provide the us
<img src="../../images/alerts/inline-alert-example.png" alt="" />
</figure>

If an inline alert is being used to communicate some general information to the user, then you can choose to allow them to dismiss the alert to get it out of their way. However, error messages are typically not dismissable by the user and persist until the issue is fixed either by the user or the system.
If an inline alert is being used to communicate some general information to the user, then you can choose to allow them to dismiss the alert to get it out of their way. However, error messages are typically not dismissible by the user and persist until the issue is fixed either by the user or the system.

<figure>
<img src="../../images/alerts/inline-alert-example-2.png" alt="" />
Expand Down
8 changes: 4 additions & 4 deletions website/react-magma-docs/src/pages/design/checkboxes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ import { LeadParagraph } from '../../components/LeadParagraph';
<PageContent componentName="checkbox" type="design">

<LeadParagraph>
A checkbox is an input control that allows a user to select one or more options from a number of choices.
A checkbox is an input control that allows a user to select one or more
options from a number of choices.
</LeadParagraph>


## Usage

Use checkboxes to:
Expand Down Expand Up @@ -91,7 +91,7 @@ The default color used for checked checkboxes is primary-500 from the Magma pale
<figcaption>
<p class="title title-incorrect">Incorrect</p>
<p>
Don't use multiple colors in the same UI. Pick one and stick with
Do not use multiple colors in the same UI. Pick one and stick with
it.
</p>
</figcaption>
Expand All @@ -106,7 +106,7 @@ The default color used for checked checkboxes is primary-500 from the Magma pale
<figcaption>
<p class="title title-incorrect">Incorrect</p>
<p>
If you're going to change the color, don't use a neutral color. This
If you are going to change the color, don't use a neutral color. This
could be confused with a checkbox that is checked and disabled.
</p>
</figcaption>
Expand Down
2 changes: 1 addition & 1 deletion website/react-magma-docs/src/pages/design/combobox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { LeadParagraph } from '../../components/LeadParagraph';

## Usage

The list is designed to help the user arrive at a value, but the value does not necessarily have to come from that list. Don't think of it like a Select, but more of a text input with some suggestions.
The list is designed to help the user arrive at a value, but the value does not necessarily have to come from that list. Do not think of it like a Select, but more of a text input with some suggestions.

![](../../images/inputs/combobox-example.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { LeadParagraph } from '../../components/LeadParagraph';

## Usage

Use the indeterminate state when the checkbox contains a sublist of selections, some of which are selected, and some unselected.
Use the indeterminate state when the checkbox contains a sub list of selections, some of which are selected, and some unselected.

View the <Link to="/design/checkboxes/">documentation for checkboxes</Link> for more details.

Expand Down
2 changes: 1 addition & 1 deletion website/react-magma-docs/src/pages/design/input.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ View <Link to="/api/textarea/">component API</Link> for text areas.

### Password

Use this input when you want keep the user's password masked for security.
Use this input when you want to keep the user's password masked for security.

View the <Link to="/design/password-input/">password input documentation</Link> for more detail.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { Link } from 'gatsby';
<PageContent componentName="password_input" type="design">

<LeadParagraph>
Use the password input when you want keep the user's password masked for security.
Use the password input when you want to keep the user's password masked for security.
</LeadParagraph>

<figure>
Expand Down
2 changes: 1 addition & 1 deletion website/react-magma-docs/src/pages/design/tag.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ A leading icon may be added to the tag. This can help clarify the meaning of a t

---

## Dismissable Tags
## Dismissible Tags

Tags can include a close button on the right side. Using this close button completely removes it from the UI. This can be especially useful for something like search filters. In this scenario, a tag could be used when applying a filter to a list of search results, and then dismissing the tag removes the filter.

Expand Down
2 changes: 1 addition & 1 deletion website/react-magma-docs/src/pages/design/toast.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Avoid displaying errors or warnings with toasts, but if you have to, then these
<p class="title title-correct">Correct</p>
<p>
Toasts displaying error messages or warnings should only be manually
dismissable.
dismissible.
</p>
</figcaption>
</figure>
Expand Down
2 changes: 1 addition & 1 deletion website/react-magma-docs/src/pages/design/toggle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { LeadParagraph } from '../../components/LeadParagraph';

## Usage

Toggle switches are a great way to adjust settings when you're simply turning something on and off. The option that the switch controls, as well as the state it's in, should be made clear from the corresponding inline label.
Toggle switches are a great way to adjust settings when you are simply turning something on and off. The option that the switch controls, as well as the state it is in, should be made clear from the corresponding inline label.

<figure>
<div class="image-container">
Expand Down

2 comments on commit 318a2f1

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

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

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

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

Please sign in to comment.