Skip to content

Commit

Permalink
Fix typos (arduino#984)
Browse files Browse the repository at this point in the history
* fix: typos in AsciiDoc_sample

* fix: typo in Serial Directory

* fix: typo in Wire directory

* fix: typos in Communication directory

* fix: typo in mouseMove.adoc

* fix: typo in switchCase.adoc file

* fix: typo in array.adoc file

* fix: typo in LICENSE file

MERCHANTIBILITY -> MERCHANTABILITY
  • Loading branch information
redyf authored Jun 8, 2024
1 parent 17d3f40 commit f2fd284
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 17 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ http://arduino.cc[serialEvent()]

[role="language"]
// Whenever you want to link to another Reference term, or more in general to a relative link,
// use the syntax shown below. Please note that the file format is subsituted by attribute.
// use the syntax shown below. Please note that the file format is substituted by attribute.
// Please note that you always need to replace spaces that you might find in folder/file names with %20
// The entire link to Reference pages must be lower case, regardless of the case of the folders and files in this repository.
* #LANGUAGE# link:../AsciiDoc_Template-Single_Entity[Single Entity]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ image::http://arduino.cc/en/uploads/Main/ArduinoUno_R3_Front_450px.jpg[caption="

[role="language"]
// Whenever you want to link to another Reference term, or more in general to a relative link,
// use the syntax shown below. Please note that the file format is subsituted by attribute.
// use the syntax shown below. Please note that the file format is substituted by attribute.
// Please note that you always need to replace spaces that you might find in folder/file names with %20
// The entire link to Reference pages must be lower case, regardless of the case of the folders and files in this repository.
// For language tag, items will be automatically generated for any other item of the same subcategory,
Expand Down
2 changes: 1 addition & 1 deletion LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,7 +264,7 @@ subject to and limited by the following restrictions:
UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR
OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY
KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE,
INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY,
INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF
LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS,
WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION
Expand Down
4 changes: 2 additions & 2 deletions Language/Functions/Communication/Print.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ subCategories: [ "Communication" ]
=== Description
The Print class is an abstract base class that provides a common interface for printing data to different output devices. It defines several methods that allow printing data in different formats.

Print class is related to several libraries in Arduino that use the printing funcionality to interact with devices such as Serial Monitor, LCD Screen, printers, etc.
Print class is related to several libraries in Arduino that use the printing functionality to interact with devices such as Serial Monitor, LCD Screen, printers, etc.

Some of the libraries that use the Print class are:

Expand Down Expand Up @@ -58,4 +58,4 @@ link:https://www.arduino.cc/reference/en/language/functions/communication/serial
=== See also

--
// SEE ALSO SECTION ENDS
// SEE ALSO SECTION ENDS
2 changes: 1 addition & 1 deletion Language/Functions/Communication/SPI.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ To read more about Arduino and SPI, you can visit the https://docs.arduino.cc/le
[#howtouse]
--
|================================================================================================================================================
| Boards | Default SPI Pins | Additonal SPI Pins | Notes
| Boards | Default SPI Pins | Additional SPI Pins | Notes
| UNO R3, UNO R3 SMD, UNO WiFi Rev2, UNO Mini Ltd| 10(CS), 11(COPI), 12(CIPO), 13(SCK) | | SPI pins available on ICSP header
| UNO R4 Minima, UNO R4 WiFi| 10(CS), 11(COPI), 12(CIPO), 13(SCK) | | SPI pins available on ICSP header
| Leonardo, Yún Rev2, Zero| 10(CS), 11(COPI), 12(CIPO), 13(SCK) | | SPI pins available on ICSP header
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Serial/print.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ void loop() {
for (int x = 0; x < 64; x++) { // only part of the ASCII chart, change to suit
// print it out in many formats:
Serial.print(x); // print as an ASCII-encoded decimal - same as "DEC"
Serial.print("\t\t"); // prints two tabs to accomodate the label length
Serial.print("\t\t"); // prints two tabs to accommodate the label length
Serial.print(x, DEC); // print as an ASCII-encoded decimal
Serial.print("\t"); // prints a tab
Expand Down
2 changes: 1 addition & 1 deletion Language/Functions/Communication/Wire.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ subCategories: [ "Communication" ]
=== Description


This library allows you to communicate with I2C devices, a feature that is present on all Arduino boards. I2C is a very common protocol, primarly used for reading/sending data to/from external I2C components. To learn more, visit link:https://docs.arduino.cc/learn/communication/wire[this article for Arduino & I2C].
This library allows you to communicate with I2C devices, a feature that is present on all Arduino boards. I2C is a very common protocol, primarily used for reading/sending data to/from external I2C components. To learn more, visit link:https://docs.arduino.cc/learn/communication/wire[this article for Arduino & I2C].

Due to the hardware design and various architectural differences, the I2C pins are located in different places. The pin map just below highlights the default pins, as well as additional ports available on certain boards.

Expand Down
4 changes: 2 additions & 2 deletions Language/Functions/Communication/Wire/getWireTimeoutFlag.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ title: getWireTimeoutFlag()
[float]
=== Description

Checks whether a timeout has occured since the last time the flag was cleared.
Checks whether a timeout has occurred since the last time the flag was cleared.

This flag is set is set whenever a timeout occurs and cleared when `Wire.clearWireTimeoutFlag()` is called, or when the timeout is changed using `Wire.setWireTimeout()`.

Expand All @@ -34,4 +34,4 @@ This function was not available in the original version of the Wire library and

--

//OVERVIEW SECTION ENDS
//OVERVIEW SECTION ENDS
8 changes: 4 additions & 4 deletions Language/Functions/Communication/Wire/setWireTimeout.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ void loop() {
Wire.write(123); // send command
byte error = Wire.endTransmission(); // run transaction
if (error) {
Serial.println("Error occured when writing");
Serial.println("Error occurred when writing");
if (error == 5)
Serial.println("It was a timeout");
}
Expand All @@ -66,7 +66,7 @@ void loop() {
#endif
byte len = Wire.requestFrom(8, 1); // request 1 byte from device #8
if (len == 0) {
Serial.println("Error occured when reading");
Serial.println("Error occurred when reading");
#if defined(WIRE_HAS_TIMEOUT)
if (Wire.getWireTimeoutFlag())
Serial.println("It was a timeout");
Expand All @@ -88,7 +88,7 @@ If `reset_on_timeout` was set to true and the platform supports this, the Wire h

When a timeout is triggered, a flag is set that can be queried with `getWireTimeoutFlag()` and must be cleared manually using `clearWireTimeoutFlag()` (and is also cleared when `setWireTimeout()` is called).

Note that this timeout can also trigger while waiting for clock stretching or waiting for a second master to complete its transaction. So make sure to adapt the timeout to accomodate for those cases if needed. A typical timeout would be 25ms (which is the maximum clock stretching allowed by the SMBus protocol), but (much) shorter values will usually also work.
Note that this timeout can also trigger while waiting for clock stretching or waiting for a second master to complete its transaction. So make sure to adapt the timeout to accommodate for those cases if needed. A typical timeout would be 25ms (which is the maximum clock stretching allowed by the SMBus protocol), but (much) shorter values will usually also work.


[float]
Expand All @@ -102,4 +102,4 @@ If you require the timeout to be disabled, it is recommended you disable it by d

--

//OVERVIEW SECTION ENDS
//OVERVIEW SECTION ENDS
2 changes: 1 addition & 1 deletion Language/Functions/USB/Mouse/mouseMove.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ int readAxis(int axisNumber) {
}
// the Y axis needs to be inverted in order to
// map the movemment correctly:
// map the movement correctly:
if (axisNumber == 1) {
distance = -distance;
}
Expand Down
2 changes: 1 addition & 1 deletion Language/Structure/Control Structure/switchCase.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ switch (var) {



// SEE ALSO SECTIN BEGINS
// SEE ALSO SECTION BEGINS
[#see_also]
--

Expand Down
2 changes: 1 addition & 1 deletion Language/Variables/Data Types/array.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ All of the methods below are valid ways to create (declare) an array.
// Declare an array of a given length without initializing the values:
int myInts[6];
// Declare an array without explicitely choosing a size (the compiler
// Declare an array without explicitly choosing a size (the compiler
// counts the elements and creates an array of the appropriate size):
int myPins[] = {2, 4, 8, 3, 6, 4};
Expand Down

0 comments on commit f2fd284

Please sign in to comment.