Skip to content

Clarify the docs for partitioned(by:) #228

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 4 commits into from
May 7, 2024
Merged

Conversation

j-f1
Copy link
Contributor

@j-f1 j-f1 commented Apr 19, 2024

As currently written, the summary for partitioned(by:) heavily implies the return value is (trueValues, falseValues). In fact, it’s the opposite. I rephrased this summary to clarify that (1) the order is (falseValues, trueValues) and (2) the elements of the two returned arrays are in the order they were in the original sequence/collection.

Checklist

  • (N/A) I've added at least one test that validates that my change is working, if appropriate
  • I've followed the code style of the rest of the project
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary

@j-f1
Copy link
Contributor Author

j-f1 commented Apr 19, 2024

@swift-ci please test

@j-f1 j-f1 requested review from mdznr and natecook1000 April 25, 2024 00:37
@j-f1
Copy link
Contributor Author

j-f1 commented Apr 26, 2024

@swift-ci please test

Copy link
Member

@natecook1000 natecook1000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One quick note (that applies to both changes), then we should be good to merge! Thanks, @j-f1!

@j-f1
Copy link
Contributor Author

j-f1 commented May 7, 2024

@swift-ci please test

@j-f1 j-f1 merged commit 34b1705 into main May 7, 2024
2 checks passed
@j-f1 j-f1 deleted the jed/clarify-partitioned-by-docs branch May 7, 2024 19:53
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants