Skip to content

Commit 483a06b

Browse files
authored
Merge pull request #183 from per1234/fix-typos
Fix typos in documentation
2 parents 993eea8 + 6f0c593 commit 483a06b

File tree

13 files changed

+21
-19
lines changed

13 files changed

+21
-19
lines changed

docs/api.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
#### Description
88

9-
Initializes the ethernet library and network settings.
9+
Initializes the Ethernet library and network settings.
1010

1111
With version 1.0, the library supports DHCP. Using Ethernet.begin(mac) with the proper network setup, the Ethernet shield will automatically obtain an IP address. This increases the sketch size significantly. To make sure the DHCP lease is properly renewed when needed, be sure to call Ethernet.maintain() regularly.
1212

@@ -2107,7 +2107,7 @@ void loop() {
21072107
Serial.print(", port ");
21082108
Serial.println(Udp.remotePort());
21092109
2110-
// read the packet into packetBufffer
2110+
// read the packet into packetBuffer
21112111
Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
21122112
Serial.println("Contents:");
21132113
Serial.println(packetBuffer);
@@ -2432,7 +2432,7 @@ void loop() {
24322432
Serial.print(", port ");
24332433
Serial.println(Udp.remotePort());
24342434
2435-
// read the packet into packetBufffer
2435+
// read the packet into packetBuffer
24362436
Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
24372437
Serial.println("Contents:");
24382438
Serial.println(packetBuffer);
@@ -2597,7 +2597,7 @@ void loop() {
25972597
Serial.print(", port ");
25982598
Serial.println(Udp.remotePort());
25992599
2600-
// read the packet into packetBufffer
2600+
// read the packet into packetBuffer
26012601
Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
26022602
Serial.println("Contents:");
26032603
Serial.println(packetBuffer);

docs/readme.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ The Arduino board communicates with the shield using the SPI bus. This is on dig
88

99
![Arduino MEGA Pin map.](./arduino_mega_ethernet_pins.png)
1010

11-
```
1211
To use this library
12+
13+
```
1314
#include <SPI.h>
1415
#include <Ethernet.h>
1516
```

examples/BarometricPressureWebServer/BarometricPressureWebServer.ino

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
SCP1000 Barometric Pressure Sensor Display
2+
SCP1000 Barometric Pressure Sensor Display
33
44
Serves the output of a Barometric Pressure Sensor as a web page.
55
Uses the SPI library. For details on the sensor, see:
@@ -216,7 +216,7 @@ void writeRegister(byte registerName, byte registerValue) {
216216

217217
//Read register from the SCP1000:
218218
unsigned int readRegister(byte registerName, int numBytes) {
219-
byte inByte = 0; // incoming from the SPI read
219+
byte inByte = 0; // incoming from the SPI read
220220
unsigned int result = 0; // result to return
221221

222222
// SCP1000 expects the register name in the upper 6 bits

examples/DhcpChatServer/DhcpChatServer.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
DHCP Chat Server
2+
DHCP Chat Server
33
44
A simple server that distributes any incoming messages to all
55
connected clients. To use, telnet to your device's IP address and type.

examples/LinkStatus/LinkStatus.ino

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/*
22
Link Status
3+
34
This sketch prints the Ethernet link status. When the
45
Ethernet cable is connected the link status should go to "ON".
56
NOTE: Only WIZnet W5200 and W5500 are capable of reporting

examples/PagerServer/PagerServer.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Pager Server
2+
Pager Server
33
44
A simple server that echoes any incoming messages to all
55
connected clients. Connect two or more telnet sessions

examples/TelnetClient/TelnetClient.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Telnet client
2+
Telnet client
33
44
This sketch connects to a telnet server (http://www.google.com)
55
using an Arduino WIZnet Ethernet shield. You'll need a telnet server

examples/UDPSendReceiveString/UDPSendReceiveString.ino

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
/*
2-
UDPSendReceiveString:
2+
UDPSendReceiveString
3+
34
This sketch receives UDP message strings, prints them to the serial port
45
and sends an "acknowledge" string back to the sender
56
@@ -82,7 +83,7 @@ void loop() {
8283
Serial.print(", port ");
8384
Serial.println(Udp.remotePort());
8485

85-
// read the packet into packetBufffer
86+
// read the packet into packetBuffer
8687
Udp.read(packetBuffer, UDP_TX_PACKET_MAX_SIZE);
8788
Serial.println("Contents:");
8889
Serial.println(packetBuffer);

examples/UdpNtpClient/UdpNtpClient.ino

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
/*
2-
32
Udp NTP Client
43
54
Get the time from a Network Time Protocol (NTP) time server

examples/WebClient/WebClient.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Web client
2+
Web client
33
44
This sketch connects to a website (http://www.google.com)
55
using an Arduino WIZnet Ethernet shield.

examples/WebClientRepeating/WebClientRepeating.ino

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
2-
Repeating Web client
2+
Repeating Web client
33
4-
This sketch connects to a a web server and makes a request
4+
This sketch connects to a web server and makes a request
55
using a WIZnet Ethernet shield. You can use the Arduino Ethernet Shield, or
66
the Adafruit Ethernet shield, either one will work, as long as it's got
77
a WIZnet Ethernet module on board.
@@ -104,7 +104,7 @@ void loop() {
104104
// this method makes a HTTP connection to the server:
105105
void httpRequest() {
106106
// close any connection before send a new request.
107-
// This will free the socket on the WiFi shield
107+
// This will free the socket on the Ethernet shield
108108
client.stop();
109109

110110
// if there's a successful connection:

examples/WebServer/WebServer.ino

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
Web Server
2+
Web Server
33
44
A simple web server that shows the value of the analog input pins.
55
using an Arduino WIZnet Ethernet shield.

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ version=2.0.0
33
author=Various (see AUTHORS file for details)
44
maintainer=Paul Stoffregen <[email protected]>, Arduino <[email protected]>
55
sentence=Enables network connection (local and Internet) using the Arduino Ethernet Board or Shield.
6-
paragraph=With this library you can use the Arduino Ethernet (shield or board) to connect to Internet. The library provides both Client and server functionalities. The library permits you to connect to a local network also with DHCP and to resolve DNS.
6+
paragraph=With this library you can use the Arduino Ethernet (shield or board) to connect to Internet. The library provides both client and server functionalities. The library permits you to connect to a local network also with DHCP and to resolve DNS.
77
category=Communication
88
url=https://www.arduino.cc/en/Reference/Ethernet
99
architectures=*

0 commit comments

Comments
 (0)