docs(Tuple): clarify 2-element tuple requirements#6162
Open
aymenhmaidiwastaken wants to merge 1 commit intoEffect-TS:mainfrom
Open
docs(Tuple): clarify 2-element tuple requirements#6162aymenhmaidiwastaken wants to merge 1 commit intoEffect-TS:mainfrom
aymenhmaidiwastaken wants to merge 1 commit intoEffect-TS:mainfrom
Conversation
Update module header and JSDoc for getFirst, getSecond, mapBoth, mapFirst, mapSecond, and swap to explicitly state they only work with 2-element tuples (pairs). Add cross-references to arbitrary-length alternatives like at() and map(). Closes Effect-TS#5069
|
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
1 participant
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
getFirst,getSecond,mapBoth,mapFirst,mapSecond, andswapto explicitly state they require tuples with exactly 2 elementsat()andmap())No code changes — JSDoc only.
Closes #5069