Improve comments in mqtt_client example

Author: Martin Crossley

pico_w/wifi/mqtt/mqtt_client.c

@@ -243,6 +243,8 @@ static void mqtt_connection_cb(mqtt_client_t *client, void *arg, mqtt_connection
         if (!state->connect_done) {
             panic("Failed to connect to mqtt server");
         }
+        // note that the main() loop will soon terminate because mqtt_client_is_connected()
+        // will return false.  
     }
     else {
         panic("Unexpected status");
@@ -368,7 +370,13 @@ int main(void) {
         panic("dns request failed");
     }
 
+    // We are not in a callback but we can get away with calling mqtt_client_is_connected()
+    // because it's a read-only operation
     while (!state.connect_done || mqtt_client_is_connected(state.mqtt_client_inst)) {
+        // As supplied the example configures cyw43_arch for thread_safe_background operation
+        // by linking `ico_cyw43_arch_lwip_threadsafe_background` in CMakeLists.txt, so the 
+        // following two lines are unnecessary (but do no harm). However you will need them 
+        // if you reconfigure the build to use cyw43_arch in polling mode.
         cyw43_arch_poll();
         cyw43_arch_wait_for_work_until(make_timeout_time_ms(10000));
     }