Skip to content

docs: follow the Dart binding to libmuslim 0.1.0 on pub.dev - #35

Closed
rizukirr wants to merge 3 commits into
mainfrom
dart-libmuslim-0.1.0
Closed

docs: follow the Dart binding to libmuslim 0.1.0 on pub.dev#35
rizukirr wants to merge 3 commits into
mainfrom
dart-libmuslim-0.1.0

Conversation

@rizukirr

@rizukirr rizukirr commented Aug 23, 2026

Copy link
Copy Markdown
Member

Updates docs/libmuslim/dart to the current state of the Dart binding. Every factual change was checked by running the library against the vendored prayertimes.h v0.2.3, not by reading the source.

The package was renamed

Published on pub.dev as libmuslim, not libmuslim_dart. The git dependency becomes dart pub add libmuslim / flutter pub add libmuslim, and every import and prose mention follows. The repository keeps the longer libmuslim-dart name, which the overview now states explicitly so the two do not read as a typo.

Three claims were false

Claim Was Is
Jakarta isha, 2026-07-12, Kemenag 19:08 19:09
Tromso midwinter, Kemenag loses maghrib alone loses asr and maghrib
HighLatMethod not exposed, "a lever wired to nothing" exposed as HighLatitudeRule

The Tromso correction appears in both quick-start.md and api-reference.md. The sun does not rise, so there is no sunset to measure maghrib from and nothing casts a shadow. The other four Jakarta times still match.

HighLatitudeRule was undocumented

It is exported but appeared nowhere in the docs. Added:

  • its own reference section, all five members
  • highLatitudeRule and highLatitudeReferenceLatitude on both CalculationParameters constructors
  • a quick start section on overriding a method's own rule
  • an errors table row, and a parameter table on .of, which previously had none
  • high latitude rule and reference latitude columns on the preset table, read from METHOD_TABLE, where only mwl (45) and moonsighting (60) carry a reference latitude

One gap documented rather than hidden

CalculationParameters.custom validates highLatitudeReferenceLatitude neither at construction nor at the PrayerTimes call, so an out of range value reaches C unchecked. .of does check it. This looks like an oversight in the binding rather than a deliberate asymmetry, so it is worth a follow up there. The docs describe the behaviour as it currently stands.

Also

Platform support replaces the "Linux only" paragraph with the five target table, keeping the caveat that Linux x64 is the only target the test suite has actually been run on. A new vendored header section records prayertimes.h v0.2.3 from release 2026.08.22.

The package is published as libmuslim rather than libmuslim_dart, so the
git dependency becomes dart pub add and every import and prose mention
follows. The repository keeps the longer libmuslim-dart name, which the
overview now says out loud so the two do not read as a typo.

Three claims were false against the current library, each checked by
running it rather than by reading the source.

Jakarta isha on 2026-07-12 under Kemenag is 19:09, not 19:08. The other
four times in the quick start still match.

Tromso midwinter under Kemenag loses asr and maghrib, not maghrib alone.
The sun does not rise, so there is no sunset to measure maghrib from and
nothing casts a shadow. Both files said maghrib alone.

HighLatMethod is no longer a lever wired to nothing. It is exposed as
HighLatitudeRule, so the C comparison row that called it unexposed is
replaced.

HighLatitudeRule was missing from the docs entirely despite being
exported. It gets its own section with all five members, the two new
parameters on both CalculationParameters constructors, a quick start
section, an errors row, and a parameter table on .of, which had none.
The preset table gains the high latitude rule and reference latitude
read from METHOD_TABLE, where only mwl and moonsighting carry a
reference latitude.

Documented as it stands rather than as it should be:
CalculationParameters.custom validates neither at construction nor at
the call, so an out of range highLatitudeReferenceLatitude reaches C
unchecked, while .of does check it.

Platform support replaces the Linux only paragraph with the five target
table, keeping the caveat that Linux x64 is the only one actually tested,
and a vendored header section records prayertimes.h v0.2.3 from release
2026.08.22.
@vercel

vercel Bot commented Aug 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
muslimtify Ready Ready Preview Aug 23, 2026 1:27pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant