Commit ecd79d79 authored by Vittorio Giovanelli's avatar Vittorio Giovanelli
Browse files

Fixed some grammar on docs

parent ca104a96
...@@ -40,7 +40,7 @@ package.loaded["ds3231"]=nil ...@@ -40,7 +40,7 @@ package.loaded["ds3231"]=nil
## setTime() ## setTime()
####Description ####Description
Sets the current date and time. Sets the current date and time.
if _disableOscillator_ is set to 1 the oscillator will **stops** on battery. if _disableOscillator_ is set to 1 the oscillator will **stop** on battery.
####Syntax ####Syntax
setTime(second, minute, hour, day, date, month, year, disableOscillator) setTime(second, minute, hour, day, date, month, year, disableOscillator)
...@@ -174,7 +174,7 @@ package.loaded["ds3231"]=nil ...@@ -174,7 +174,7 @@ package.loaded["ds3231"]=nil
## reloadAlarms() ## reloadAlarms()
####Description ####Description
Reload an already triggered alarm. Otherwise it will never be triggered again. Reload an already triggered alarm. Otherwise it will never be triggered again.
Alarms have to be reloaded both to let them triggers. There are two different alarms and they have to be reloaded both to let, even only one, to be triggered again. So there isn't a param to select which alarm to reload.
####Syntax ####Syntax
reloadAlarms() reloadAlarms()
...@@ -211,7 +211,7 @@ package.loaded["ds3231"]=nil ...@@ -211,7 +211,7 @@ package.loaded["ds3231"]=nil
<a id="ds3231_enableAlarm"></a> <a id="ds3231_enableAlarm"></a>
## enableAlarm() ## enableAlarm()
####Description ####Description
Enable an already setted alarm with the previous matching conditions. It reload alarms internally. Enable an already setted alarm with the previous matching conditions. It reloads alarms internally.
####Syntax ####Syntax
enableAlarm(alarmId) enableAlarm(alarmId)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment