Skip to content

Made usage documentation more clear #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ArztKlein wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Made usage documentation more clear #17

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@ To use Python Lunar in a project::

>>> import pylunar

Location: Boston, MA, USA
Get moon info by entering the location using DMS coordinates.
Example: Location - Wellington, New Zealand
Copy link
Owner

@mareuter mareuter Dec 30, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The numeric coordinates specified in the following line are for Boston not Wellington, so the location text should be Boston, MA, USA like the original. This also matches the time zone adjustment below which is set for Boston and not Wellington.


>>> mi = pylunar.MoonInfo((42, 21, 30), (-71, 3, 35))

Local Time: July 18, 2016 at 21:45

API requires UTC, so add 4 hours since on Daylight Savings (changes day)
API requires UTC, so adjust local timezone to utc.
Example: adds 4 hours since Daylight Savings (changes day)

>>> mi.update((2016, 7, 19, 1, 45, 0))
>>> mi.age()
Expand Down