Skip to content
This repository was archived by the owner on Jul 22, 2023. It is now read-only.

Commit a3f6fa6

Browse files
committed
Fix User Guide Links to Headings
We must use all lower case, remove the colons, and substitute spaces for hypens to get heading links working correctly. See the code that creates links here: https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb * downcases the string * removes anything that is not a letter, number, space or hyphen (see the source for how Unicode is handled) * changes any space to a hyphen. * if that is not unique, add "-1", "-2", "-3",... to make it unique
1 parent 09f84c8 commit a3f6fa6

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/user_guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -204,11 +204,11 @@ To connect to Cloud IoT Core, call **`iotc_connect()`**. This function enqueues
204204
* TLS handshaking and certificate validation
205205
* MQTT credential handshaking
206206

207-
Note: the call to connect returns immediately. The connection operation is fulfilled on subsequent calls to the Device SDK's event processing functions, as described in [Step 3: Process Events](step-3-process-events).
207+
Note: the call to connect returns immediately. The connection operation is fulfilled on subsequent calls to the Device SDK's event processing functions, as described in [Step 3: Process Events](#step-3-process-events).
208208

209209
#### Connect callback
210210

211-
When the **`iotc_connect()`** function runs, the Device SDK initalizes a callback function. The callback function is invoked when a connection to Cloud IoT Core is established or when the connection is unsuccessful. The callback function is also invoked when an established connection is lost or shut down. See [Step 6: Disconnect and Shut Down](step-6-disconnect-and-shut-down) for details.
211+
When the **`iotc_connect()`** function runs, the Device SDK initalizes a callback function. The callback function is invoked when a connection to Cloud IoT Core is established or when the connection is unsuccessful. The callback function is also invoked when an established connection is lost or shut down. See [Step 6: Disconnect and Shut Down](#step-6-disconnect-and-shut-down) for details.
212212

213213
### Step 3: Process events
214214

@@ -228,7 +228,7 @@ Incoming messages include the topic data as part of the callback parameters. Spe
228228

229229
#### QoS level
230230

231-
The [specified QoS level](#MQTT v3.1.1) is the maximum QoS level of incoming messages. For instance, if you set the QoS level to 0, QoS 1 messages are downgraded to QoS 0.
231+
The [specified QoS level](#mqtt-v3.1.1) is the maximum QoS level of incoming messages. For instance, if you set the QoS level to 0, QoS 1 messages are downgraded to QoS 0.
232232

233233
The QoS level also affects the Device SDK's memory overhead. QoS 2 messages use the most memory overhead, while QoS 0 messages use the least.
234234

@@ -250,17 +250,17 @@ This callback function is for environments with severe memory restrictions. For
250250

251251
### Step 6: Disconnect and shut down
252252

253-
To disconnect from Cloud IoT Core, invoke the **`iotc_shutdown_connection()`** function. This function enqueues an event that cleanly closes the socket connection. After the connection is terminated, the Device SDK invokes the [connect callback](#Step 2: Connect) function.
253+
To disconnect from Cloud IoT Core, invoke the **`iotc_shutdown_connection()`** function. This function enqueues an event that cleanly closes the socket connection. After the connection is terminated, the Device SDK invokes the [connect callback](#step-2-connect) function.
254254

255255
Note: Do not delete the context until the the connect callback is invoked.
256256

257257
#### Disconnection types and reconnecting
258258

259259
The Device SDK checks the parameters of the connect callback function to determine if a device was intentionally or incidentally disconnected. See the [**Connect callback**](#connect-callback) section for more information.
260260

261-
If an error disconnects a device, the client application can safely and immediately call **`iotc_connect()`** from within the connect callback function itself, using the same context that was just disconnected. This ques a new [connection request](#Step 2: Connect).
261+
If an error disconnects a device, the client application can safely and immediately call **`iotc_connect()`** from within the connect callback function itself, using the same context that was just disconnected. This ques a new [connection request](#step-2-connect).
262262

263-
If a client application intentionally closes a connection, it retains the [existing context](#Step 1: Create a context) and invokes the connect function again later.
263+
If a client application intentionally closes a connection, it retains the [existing context](#step-1-create-a-context) and invokes the connect function again later.
264264

265265
#### Freeing memory and shutting down
266266

0 commit comments

Comments
 (0)