bitwalker/timex

Most functions are incorrect for calendars other than Calendar.ISO

Open

#449 opened on Jul 30, 2018

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Elixir (1,807 stars) (406 forks)batch import
feature/enhancementhelp wantedlevel:advanced

Description

Most functions in Timex manipulate the Elixir data structures directly. In doing so, they assume a lot about the underlying calendar - in most cases the functions would just not work for anything other than Calendar.ISO. The prime example would be Timex.shift/2.

Timex should either amend those functions to be correct in case they are called with other calendars, or pattern match on the value and document the functions to only work with Calendar.ISO.

Contributor guide

Tech stack
elixir
Domain
backend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
ElixirTimex libraryCalendar module
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Examine the Timex source code to identify which functions manipulate Elixir data structures directly and assume ISO calendar. Focus on `Timex.shift/2` and similar functions. Check the documentation to see if there are existing guards or pattern matches. Decide whether to add calendar aware implementations or restrict to ISO and update docs accordingly. Consider looking at the `Calendar` module in Elixir for guidance on supporting multiple calendars.