docs: sync README API map with current exports#11
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #11 +/- ##
=======================================
Coverage 91.68% 91.68%
=======================================
Files 23 23
Lines 397 397
Branches 90 90
=======================================
Hits 364 364
Misses 11 11
Partials 22 22
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Update the API map table in packages/plainfp/README.md so the Result and Option rows reflect what the barrels actually export. Result now lists: tap, tapError, toOption (added in batch #1 and #2). Option now lists: tap, tapNone, all, any, zip, toResult (same). Verified every listed symbol against packages/plainfp/src/<namespace>/index.ts; result-async / arrays / records / strings / predicates / functions / brand / non-empty-array / tagged / interop/zod rows were already correct.
2efec8a to
30549a3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Pre-release hygiene: the API map table in `packages/plainfp/README.md` hadn't been updated since a few of the 0.1.0 additions landed. This PR aligns the Result and Option rows with what the barrels actually export.
Changes
All other namespaces (result-async, arrays, records, strings, predicates, functions, brand, non-empty-array, tagged, interop/zod) were already accurate — verified by cross-referencing each row against its `src//index.ts`.
Why now
Two-line fix before cutting 0.1.0 so the published npm page doesn't advertise an incomplete API surface. Integration tests PR to follow.
Test plan