added comments

Author: ciarajekel

examples/Example1_BasicReadings/Example1_BasicReadings.ino

@@ -27,6 +27,7 @@ void setup() {
     while (1);
   }
   //Initializes sensor for air quality readings
+  //measureAirQuality should be called in one second increments after a call to initAirQuality
   mySensor.initAirQuality();
 }
 

examples/Example2_RawSignals/Example2_RawSignals.ino

@@ -30,6 +30,7 @@ void setup() {
     while (1);
   }
   //Initializes sensor for air quality readings
+  //measureAirQuality should be called in one second increments after a call to initAirQuality
   mySensor.initAirQuality();
   t1 = millis();
 }

examples/Example3_Humidity/Example3_Humidity.ino

@@ -45,6 +45,7 @@ void setup() {
   //Convert the double type humidity to a fixed point 8.8bit number
   uint16_t sensHumidity = doubleToFixedPoint(absHumidity);
   //Initializes sensor for air quality readings
+  //measureAirQuality should be called in one second increments after a call to initAirQuality
   mySensor.initAirQuality();
   //Set the humidity compensation on the SGP30 to the measured value
   //If no humidity sensor attached, sensHumidity should be 0 and sensor will use default

examples/Example4_ErrorChecking/Example4_ErrorChecking.ino

@@ -31,8 +31,9 @@ void setup() {
     while (1);
   }
   //Initializes sensor for air quality readings
+  //measureAirQuality should be called in one second increments after a call to initAirQuality
   mySensor.initAirQuality();
-    t1 = millis();
+  t1 = millis();
 }
 
 void loop() {

examples/Example6_SchedulerReadings/Example6_SchedulerReadings.ino

@@ -38,6 +38,7 @@ void setup() {
   runner.init();
   //add task t1 to the schedule
   runner.addTask(t1);
+  //measureAirQuality should be called in one second increments after a call to initAirQuality
   mySensor.initAirQuality();
   //enable t1 to run
   t1.enable();

examples/Example7_Reset/Example7_Reset.ino

@@ -30,6 +30,7 @@ void setup() {
     Serial.println("No SGP30 Detected. Check connections.");
     while (1);
   }
+  //measureAirQuality should be called in one second increments after a call to initAirQuality
   mySensor.initAirQuality();
   //First fifteen readings will be
   //CO2: 400 ppm  TVOC: 0 ppb

examples/Example8_OtherI2C/Example8_OtherI2C.ino

@@ -27,6 +27,7 @@ void setup() {
     while (1);
   }
   //Initializes sensor for air quality readings
+  //measureAirQuality should be called in one second increments after a call to initAirQuality
   mySensor.initAirQuality();
   t1 = millis();
 }

library.properties

@@ -3,7 +3,8 @@ version=1.0.0
 author=SparkFun Electronics
 maintainer=SparkFun Electronics
 sentence=Library for the Sensirion SGP30 air quality sensor
-paragraph=
+paragraph=The SGP30 is an indoor air quality sensor equipped with an I<sup>2</sup>C interface. It outputs equivalent CO<sub>2</sub> in ppm and Total Volatile Organic Compounds (TVOC) in ppb. The sensor also gives access to its raw measurement values of Ethanol and H<sub>2</sub>. 
+
 category=Sensors
 url=https://github.com/sparkfun/SparkFun_SGP30_Library
 architectures=*