linkedin / linkedin/pyexchange

Review and add doc around timezone handling

Open
#36 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
154
Forks
91
PR merge metrics
No merged PRs in 30d

Description

It sounds like the docs aren't clear around us returning UTC datetimes rather than localtime (see issue #35) so we should review and make it less confusing.

Need to include the reasoning on why we return UTC and not localtimes (see SO question linked in #35 and use that summary)

Contributor guide

Open the contributing guide

Research direction

Start by reading issue #35 and the linked Stack Overflow question, then locate the project documentation covering timezone handling. Update that documentation to explain that returned datetimes use UTC rather than local time and include the referenced reasoning; done means the distinction and rationale are clear to readers.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.