From be7034534baf420ef3abc7fce451df4f9444fde0 Mon Sep 17 00:00:00 2001 From: Simon Kennedy Date: Mon, 29 Jan 2018 13:04:51 +0000 Subject: [PATCH] Added paragraph regarding the return type from moon_phase --- src/doc/index.rst | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/src/doc/index.rst b/src/doc/index.rst index d104278..67e4a1e 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -154,14 +154,17 @@ Moon >>> print(moon_phase) 13 -The moon phase method returns an integer describing the phase, where the value is between 0 and 27. -The foloowing lists the mapping of various vales to the description of the phase of the moon. +The moon phase method returns an number describing the phase, where the value is between 0 and 27. +The following lists the mapping of various vales to the description of the phase of the moon. | 0 = New moon | 7 = First quarter | 14 = Full moon | 21 = Last quarter +The return value can be cast to either an integer (the default or a float by passing the +type required as the `rtype` parameter to :meth:`moon_phase` + .. note :: The moon phase does not depend on your location. However what the moon