Skip to content

Commit

Permalink
docs: typo and grammar corrections
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeremy-Rivera committed Nov 26, 2024
1 parent 5031da6 commit 5cc523b
Show file tree
Hide file tree
Showing 7 changed files with 6 additions and 23,672 deletions.
2 changes: 1 addition & 1 deletion doc/issue_impact.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For a list of all rules and their associated impacts, see [rule-descriptions.md]

### Minor

Considered to be a nuisance or an annoyance bug. Prioritize fixing it if the fix only takes a few minutes and the developer is working on the same screen/feature at the same time, otherwise the issue should not be prioritized. This issue will still get in the way of compliance if not fixed.
Considered to be a nuisance or an annoyance bug. Prioritize fixing it if the fix only takes a few minutes and the developer is working on the same screen/feature at the same time, otherwise the issue should not be prioritized. Will still get in the way of compliance if not fixed.

### Moderate

Expand Down
2 changes: 1 addition & 1 deletion doc/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The act plugin will simply perform an action of some sort inside every iframe on

Plugins currently support two functions: a "run" function and a "collect" function. Together these functions can be combined to implement complex behaviors on top of the axe system.

To create such a plugin, we need to implement the 'run' function and the command that registers and executes the 'run' function within each iframe on the page containing axe. Let's look at what a noop implementation of this run function would look like:
To create such a plugin, we need to implement the `run` function and the command that registers and executes the `run` function within each iframe on the page containing axe. Let's look at what a noop implementation of this run function would look like:

#### Basic plugin

Expand Down
2 changes: 1 addition & 1 deletion doc/release-and-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ In order to ensure the best quality from axe-core, we encourage everyone to regu

Additionally, we recommend that you always use the latest patch version of whichever minor version you are on. For example if you are using axe-core 3.5.5, and 3.5.6 is released it is best to upgrade immediately. Patch releases of axe-core should not find new issues, although they occasionally resolve issues in the case of false positives.

Ensuring that you always use the latest available patch version of axe-core guarantees that you are using the most secure version. This minor line must have been released within the last 18 months. See [security updates](#security-updates).
Ensuring that you always use the latest available patch version of axe-core on any minor line guarantees that you are using the most secure version. This minor line must have been released within the last 18 months. See [security updates](#security-updates).
2 changes: 1 addition & 1 deletion doc/run-partial.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ function runPartialRecursive(context, options = {}, win = window) {

**important**: The order in which these methods are called matters for performance. Internally, axe-core constructs a flattened tree when `axe.utils.getFrameContexts` is called. This is fairly slow, and so should not happen more than once per frame. When `axe.runPartial` is called, that tree will be used if it still exists. Since this tree can get out of sync with the actual DOM, it is important to call `axe.runPartial` immediately after `axe.utils.getFrameContexts`.

To run efficiently, `axe.runPartial` calls should happen in parallel, so that, when possible, browsers can test multiple frames simultaneously.
To run efficiently, `axe.runPartial` calls should happen in parallel so that, when possible, browsers can test multiple frames simultaneously.

## axe.finishRun(partialResults, options): Promise<AxeResults>

Expand Down
4 changes: 2 additions & 2 deletions doc/standards-object.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ The [`ariaAttrs`](../lib/standards/aria-attrs.js) object defines valid ARIA attr
- `type` - string(required). The attribute type which dictates the valid values of the attribute. Valid types are:
- `boolean` - Boolean attributes only accept `true` or `false` as valid values (e.g. `aria-selected`).
- `nmtoken` - Name token attributes accept a single value from a list of valid values (e.g. `aria-orientation`).
- `nmtokens` - Name tokens attributes accept a space separated list of values from a list of valid values (e.g. `aria-relevant`).
- `mntokens` - Name tokens attributes accept a space separated list of values from a list of valid values (e.g. aria-relevant).
- `idref` - ID reference attributes accept an ID to point to another element in the DOM (e.g. `aria-activedescendant`).
- `idrefs` - ID references attributes accept a space separated list of IDs that point to multiple elements in the DOM (e.g. `aria-labelledby`).
- `string` - String attributes accept any string (e.g. `aria-label`).
- `decimal` - Decimal attributes accept any number or decimal value (e.g. `aria-valuemax`).
- `int` - Integer attributes only accept whole number values (e.g. `aria-level`).
- `values` - array(required for only `nmtoken` and `nmtokens`). The list of valid values for the attribute.
- `values` - array(required for only mntoken and mntokens). The list of valid values for the attribute.
- `minValue` - number(required for only `int`). The minimum value allowed for the attribute.
- `allowEmpty` - boolean(optional, default `false`). If the attribute is allowed to have no value.
- `global` - boolean(optional, default `false`). If the attribute is a [global ARIA attribute](https://www.w3.org/TR/wai-aria-1.1/#global_states).
Expand Down
Loading

0 comments on commit 5cc523b

Please sign in to comment.