Wrong text in DS3231/Documentation/Time-Retrieval.md

NorthernWidget / DS3231

Communicates between Arduino-programmed AVR and Maxim DS3231 RTC: splice of Ayars' (http://hacks.ayars.org/2011/04/ds3231-real-time-clock.html) and Jeelabs/Ladyada's (https://github.com/adafruit/RTClib) libraries

The Unlicense

186 stars 81 forks source link

Wrong text in DS3231/Documentation/Time-Retrieval.md #78

Closed GerardWassink closed 1 year ago

GerardWassink commented 1 year ago

In that document, under the description of the getYear() function, there's a piece of text as follows: _/*

returns: byte = 00 to 99
parameters: none
asserts: none
side effects: none
DS3231 register addressed: 0x06 */

byte theDate = myRTC.getDate();_

Which no doubt should have been:

_/*

returns: byte = 00 to 99
parameters: none
asserts: none
side effects: none
DS3231 register addressed: 0x06 */

byte theYear = myRTC.getYear();_

Gerard

IowaDave commented 1 year ago

Good catch, thanks! Closing this issue as resolved.