Skip to content

Commit

Permalink
Added paragraph regarding the return type from moon_phase
Browse files Browse the repository at this point in the history
  • Loading branch information
sffjunkie committed Jan 29, 2018
1 parent 249bf2b commit be70345
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions src/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit be70345

Please sign in to comment.