Merge pull request #183 from per1234/fix-typos

per1234 · web-flow · commit 483a06b1d350 · 2022-02-23T04:20:59.000-08:00
Fix typos in documentation
diff --git a/docs/api.md b/docs/api.md
@@ -6,7 +6,7 @@
 
 #### Description
 
-Initializes the ethernet library and network settings.
+Initializes the Ethernet library and network settings.
 
 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.
 
@@ -2107,7 +2107,7 @@ void loop() {
     Serial.print(", port ");
     Serial.println(Udp.remotePort());
 
-    // read the packet into packetBufffer
+    // read the packet into packetBuffer
     Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
     Serial.println("Contents:");
     Serial.println(packetBuffer);
@@ -2432,7 +2432,7 @@ void loop() {
     Serial.print(", port ");
     Serial.println(Udp.remotePort());
 
-    // read the packet into packetBufffer
+    // read the packet into packetBuffer
     Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
     Serial.println("Contents:");
     Serial.println(packetBuffer);
@@ -2597,7 +2597,7 @@ void loop() {
     Serial.print(", port ");
     Serial.println(Udp.remotePort());
 
-    // read the packet into packetBufffer
+    // read the packet into packetBuffer
     Udp.read(packetBuffer,UDP_TX_PACKET_MAX_SIZE);
     Serial.println("Contents:");
     Serial.println(packetBuffer);
diff --git a/docs/readme.md b/docs/readme.md
@@ -8,8 +8,9 @@ The Arduino board communicates with the shield using the SPI bus. This is on dig
 
 ![Arduino MEGA Pin map.](./arduino_mega_ethernet_pins.png)
 
-```
 To use this library
+
+```
 #include <SPI.h>
 #include <Ethernet.h>
 ```
diff --git a/examples/BarometricPressureWebServer/BarometricPressureWebServer.ino b/examples/BarometricPressureWebServer/BarometricPressureWebServer.ino
@@ -1,5 +1,5 @@
 /*
-  SCP1000 Barometric Pressure Sensor Display
+ SCP1000 Barometric Pressure Sensor Display
 
  Serves the output of a Barometric Pressure Sensor as a web page.
  Uses the SPI library. For details on the sensor, see:
@@ -216,7 +216,7 @@ void writeRegister(byte registerName, byte registerValue) {
 
 //Read register from the SCP1000:
 unsigned int readRegister(byte registerName, int numBytes) {
-  byte inByte = 0;           // incoming from  the SPI read
+  byte inByte = 0;           // incoming from the SPI read
   unsigned int result = 0;   // result to return
 
   // SCP1000 expects the register name in the upper 6 bits
diff --git a/examples/DhcpChatServer/DhcpChatServer.ino b/examples/DhcpChatServer/DhcpChatServer.ino
@@ -1,5 +1,5 @@
 /*
- DHCP Chat  Server
+ DHCP Chat Server
 
  A simple server that distributes any incoming messages to all
  connected clients.  To use, telnet to your device's IP address and type.
diff --git a/examples/LinkStatus/LinkStatus.ino b/examples/LinkStatus/LinkStatus.ino
@@ -1,5 +1,6 @@
 /*
   Link Status
+
   This sketch prints the Ethernet link status. When the
   Ethernet cable is connected the link status should go to "ON".
   NOTE: Only WIZnet W5200 and W5500 are capable of reporting
diff --git a/examples/PagerServer/PagerServer.ino b/examples/PagerServer/PagerServer.ino
@@ -1,5 +1,5 @@
 /*
- Pager  Server
+ Pager Server
 
  A simple server that echoes any incoming messages to all
  connected clients. Connect two or more telnet sessions
diff --git a/examples/TelnetClient/TelnetClient.ino b/examples/TelnetClient/TelnetClient.ino
@@ -1,5 +1,5 @@
 /*
-  Telnet client
+ Telnet client
 
  This sketch connects to a telnet server (http://www.google.com)
  using an Arduino WIZnet Ethernet shield.  You'll need a telnet server
diff --git a/examples/UDPSendReceiveString/UDPSendReceiveString.ino b/examples/UDPSendReceiveString/UDPSendReceiveString.ino
@@ -1,5 +1,6 @@
 /*
- UDPSendReceiveString:
+ UDPSendReceiveString
+
  This sketch receives UDP message strings, prints them to the serial port
  and sends an "acknowledge" string back to the sender
 
@@ -82,7 +83,7 @@ void loop() {
     Serial.print(", port ");
     Serial.println(Udp.remotePort());
 
-    // read the packet into packetBufffer
+    // read the packet into packetBuffer
     Udp.read(packetBuffer, UDP_TX_PACKET_MAX_SIZE);
     Serial.println("Contents:");
     Serial.println(packetBuffer);
diff --git a/examples/UdpNtpClient/UdpNtpClient.ino b/examples/UdpNtpClient/UdpNtpClient.ino
@@ -1,5 +1,4 @@
 /*
-
  Udp NTP Client
 
  Get the time from a Network Time Protocol (NTP) time server
diff --git a/examples/WebClient/WebClient.ino b/examples/WebClient/WebClient.ino
@@ -1,5 +1,5 @@
 /*
-  Web client
+ Web client
 
  This sketch connects to a website (http://www.google.com)
  using an Arduino WIZnet Ethernet shield.
diff --git a/examples/WebClientRepeating/WebClientRepeating.ino b/examples/WebClientRepeating/WebClientRepeating.ino
@@ -1,7 +1,7 @@
 /*
-  Repeating Web client
+ Repeating Web client
 
- This sketch connects to a a web server and makes a request
+ This sketch connects to a web server and makes a request
  using a WIZnet Ethernet shield. You can use the Arduino Ethernet Shield, or
  the Adafruit Ethernet shield, either one will work, as long as it's got
  a WIZnet Ethernet module on board.
@@ -104,7 +104,7 @@ void loop() {
 // this method makes a HTTP connection to the server:
 void httpRequest() {
   // close any connection before send a new request.
-  // This will free the socket on the WiFi shield
+  // This will free the socket on the Ethernet shield
   client.stop();
 
   // if there's a successful connection:
diff --git a/examples/WebServer/WebServer.ino b/examples/WebServer/WebServer.ino
@@ -1,5 +1,5 @@
 /*
-  Web Server
+ Web Server
 
  A simple web server that shows the value of the analog input pins.
  using an Arduino WIZnet Ethernet shield.
diff --git a/library.properties b/library.properties
@@ -3,7 +3,7 @@ version=2.0.0
 author=Various (see AUTHORS file for details)
 maintainer=Paul Stoffregen <paul@pjrc.com>, Arduino <info@arduino.cc>
 sentence=Enables network connection (local and Internet) using the Arduino Ethernet Board or Shield.
-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.
+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.
 category=Communication
 url=https://www.arduino.cc/en/Reference/Ethernet
 architectures=*

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`/*`
`2`		`-`
`3`	`2`	`Udp NTP Client`
`4`	`3`
`5`	`4`	`Get the time from a Network Time Protocol (NTP) time server`