Update comment for DateTime function in radiation.go

The comment for the DateTime function in radiation.go was updated to more accurately describe its functionality. The previous version of the comment suggested that the function returns a boolean value indicating the availability of a radiation value at the time of a query. However, the function actually returns a time.Time object representing the date and time of the query. The comment was thus updated to reflect this.
This commit is contained in:
Winni Neessen 2023-06-27 19:01:37 +02:00
parent 513d7b863f
commit e3756a5466
Signed by: wneessen
GPG key ID: 5F3AF39B820C119D

View file

@ -20,8 +20,8 @@ func (r Radiation) IsAvailable() bool {
return !r.na
}
// DateTime returns true if an Radiation value was
// available at time of query
// DateTime returns the time.Time object representing the date and time
// at which the Radiation value was queried
func (r Radiation) DateTime() time.Time {
return r.dt
}