Skip to content

Conversation

@LemonSpike
Copy link
Contributor

@LemonSpike LemonSpike commented Apr 19, 2021

I think this is what the partitionIndex method needs to be described as per #131, please let me know any feedback 😊.

Checklist

  • 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

README.md Outdated
- [`split(maxSplits:omittingEmptySubsequences:whereSeparator)`, `split(separator:maxSplits:omittingEmptySubsequences)`](https://github.com/apple/swift-algorithms/blob/main/Guides/LazySplit.md): Lazy versions of the Standard Library's eager operations that split sequences and collections into subsequences separated by the specified separator element.
- [`windows(ofCount:)`](https://github.com/apple/swift-algorithms/blob/main/Guides/Windows.md): Breaks a collection into overlapping subsequences where elements are slices from the original collection.

#### Binary Search Partitions
Copy link
Contributor

Choose a reason for hiding this comment

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

If this deserves its own heading, then it should follow the same capitalization and grammatical phrasing as other headings, and it should be above "Other useful operations"; otherwise, it should be added to the latter section in alphabetical order.

Copy link
Contributor Author

@LemonSpike LemonSpike Apr 19, 2021

Choose a reason for hiding this comment

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

Thanks for the feedback @xwu! I was following issue #131

It needs to be in a different category, though.

Just checking if the new heading of "Other useful operations" is OK if placed in alphabetical order? I will make this change but just wanted to confirm if category means heading. Thanks.

Copy link
Member

Choose a reason for hiding this comment

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

Let's add it to "Other useful operations" for now, thanks!

Co-authored-by: Nate Cook <[email protected]>
@natecook1000
Copy link
Member

@swift-ci Please test

Co-authored-by: Xiaodi Wu <[email protected]>
@natecook1000
Copy link
Member

@swift-ci Please test

@natecook1000 natecook1000 merged commit 66a56e3 into apple:main May 3, 2021
@LemonSpike LemonSpike deleted the partitioning-index-docs-update branch May 4, 2021 14:33
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.

3 participants