Skip to content

docs: update README and changelog metadata#16

Merged
rasheedja merged 1 commit into
masterfrom
rasheedja/update-changelog-docs
Jul 10, 2026
Merged

docs: update README and changelog metadata#16
rasheedja merged 1 commit into
masterfrom
rasheedja/update-changelog-docs

Conversation

@rasheedja

@rasheedja rasheedja commented Jul 9, 2026

Copy link
Copy Markdown
Owner

Summary

  • refresh README signatures and example usage for VarDomainMap, multiple objectives, and SimplexResult
  • clarify that SimplexResult.feasibleSystem is for the transformed internal problem while optimal var maps are postprocessed
  • document lower-level phase function assumptions for already-transformed/non-negative systems
  • update stale changelog project name and release links
  • restore the missing GitHub v0.2.0.0 tag link to match the Hackage release

Changelog

  • no unreleased bug-fix entry: the fresh-variable bug only existed on unreleased master

Release tag verification

  • v0.2.0.0 points to 72d536a
  • Hackage 0.2.0.0 was uploaded shortly after that commit
  • packaged files in the Hackage tarball match that commit exactly

Checks

  • nix develop --command cabal check
  • nix develop --command make format-check

@rasheedja rasheedja force-pushed the rasheedja/update-changelog-docs branch from 7c28644 to 86bd20f Compare July 9, 2026 13:52
@rasheedja rasheedja changed the title docs: update changelog and README for simplex API docs: update README for simplex API Jul 9, 2026
@rasheedja rasheedja force-pushed the rasheedja/update-changelog-docs branch from 86bd20f to ea268fc Compare July 9, 2026 14:00
@rasheedja rasheedja changed the title docs: update README for simplex API docs: update README and changelog metadata Jul 9, 2026
- Refresh README examples and signatures for VarDomainMap, multiple objectives, and SimplexResult

- Clarify transformed feasible systems and lower-level solver assumptions

- Update stale changelog project name and release links, including the restored v0.2.0.0 tag
@rasheedja rasheedja force-pushed the rasheedja/update-changelog-docs branch from ea268fc to f593289 Compare July 10, 2026 17:41
@rasheedja rasheedja merged commit 389ea32 into master Jul 10, 2026
23 checks passed
@rasheedja rasheedja deleted the rasheedja/update-changelog-docs branch July 10, 2026 17:45
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