Skip to content

Commit ee498fe

Browse files
committed
fix spelling errors
1 parent cc54fcf commit ee498fe

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/source/contrib/style_guide/ftc-docs-accessibility-guidelines.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,9 @@ Success Criterion 2.4.4 Link Purpose (In Context) - Level A
8989

9090
The purpose of each link can be determined from the link text alone or from the link text together with its programmatically determined link context, except where the purpose of the link would be ambiguous to users in general.
9191

92-
- FTC Docs has intentially choosen to open links to external sites in new tabs. This is done with Javascript.
92+
- FTC Docs has intentionally chosen to open links to external sites in new tabs. This is done with JavaScript.
9393

94-
This does preserve your current location in FTC Docs and may be convienient for sighted users who can easily close the new tab.
94+
This does preserve your current location in FTC Docs and may be convenient for sighted users who can easily close the new tab.
9595
This is an accessibility issue related to unexpected context switching, it also creates a new browser tab that some users might have trouble noticing or closing.
9696
It also prevents the *back* browser command from working.
9797

@@ -104,7 +104,7 @@ The purpose of each link can be determined from the link text alone or from the
104104
**FTC Docs To Do**
105105

106106
- We link to some files like a PDF without warning the user. PDFs often result in a context switch to a PDF viewer.
107-
- I have been surpised a few times when links I thought would be a FTC Docs page actually took me to a PDF or to *FIRST* Inspires web page.
107+
- I have been surprised a few times when links I thought would be a FTC Docs page actually took me to a PDF or to *FIRST* Inspires web page.
108108
The Persona Pages are bad for this. There are grid button links that sometimes take you to a ftc-docs page but often take you to another site with no warning.
109109
Ideally all Persona pages should link to FTC Docs pages, some of which might be Gateway Pages to the main *FIRST* site.
110110
- See the :ref:`contrib/style_guide/style-guide:links` section of the Style Guide.
@@ -119,7 +119,7 @@ Make it easier for users to operate functionality through various inputs beyond
119119

120120
- We might want to enhance functionality for mobile users and other forms of input.
121121
But we need to be careful not to introduce problems.
122-
For example, important content in a tooltip that only shows with mouse hover and is not keyboard accessible or accessbile on a mobile device.
122+
For example, important content in a tooltip that only shows with mouse hover and is not keyboard accessible or accessible on a mobile device.
123123

124124
Principle 3 – Understandable
125125
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
@@ -135,7 +135,7 @@ Make text content readable and understandable.
135135

136136
- Plain language means communicating in a way that’s clear, straightforward, and easy to understand. It helps audiences “get” what you’re saying immediately. See https://evolvingweb.com/blog/plain-language-guide-how-write-inclusive-digital-content-2024.
137137
- Some FTC Docs pages have acronyms and excess punctuation that screen readers had trouble with. Revising the text to make it more accessible would make it more readable and understandable for all users.
138-
- It's ok to discuss a complex subject, but given the wide audience for FTC Docs content authors should consider perhaps a simplified introduction or summary that builds in complexity and/or add links to background information.
138+
- It's OK to discuss a complex subject, but given the wide audience for FTC Docs content authors should consider perhaps a simplified introduction or summary that builds in complexity and/or add links to background information.
139139

140140
Principle 4 – Robust
141141
^^^^^^^^^^^^^^^^^^^^

docs/source/contrib/style_guide/style-guide.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ The standard text formatting markup is quite simple - use:
184184

185185
* One Asterisk: \*text\* for emphasis (italics) - like *text*
186186
* Two Asterisks: \*\*text\*\* for strong emphasis (boldface) - like **text**
187-
* Two Backquotes: \`\`text\`\` for literals - like ``text``
187+
* Two Backticks: \`\`text\`\` for literals - like ``text``
188188

189189
Use literals for filenames, function, and variable names.
190190

@@ -211,7 +211,7 @@ Use one space between sentences.
211211
Tables
212212
------
213213

214-
There are many ways to create tables, FTC Docs perfers the `list <https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table>`_
214+
There are many ways to create tables, FTC Docs prefers the `list <https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table>`_
215215
or `CSV <https://docutils.sourceforge.io/docs/ref/rst/directives.html#csv-table-1>`_ style of RST table.
216216
Please avoid the ASCII art form of table.
217217

@@ -240,7 +240,7 @@ Which creates the following:
240240
Admonitions
241241
-----------
242242

243-
Admonitions are RST directives that provide special formating to the admonition text.
243+
Admonitions are RST directives that provide special formatting to the admonition text.
244244
In FTC docs admonitions have a color heading, followed by a color shaded block with the admonition text.
245245
The list of admonitions is: "attention", "caution", "danger", "error", "hint", "important", "note", "tip", "warning".
246246
FTC Docs has lots of "note" and "warning" admonitions.

0 commit comments

Comments
 (0)