Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

.Net: Hide Memory Collection types for internal usage only #3175

Merged
merged 3 commits into from
Oct 16, 2023

Conversation

dmytrostruk
Copy link
Member

Motivation and Context

Resolves: #3152

This PR contains changes to make Memory Collection types as internal. As alternative, developers can use PriorityQueue type, available in .NET 6, 7, 8.

Description

  1. Hide Memory Collection types.
  2. Removed unit tests for hidden types, as they are covered with tests for public type that uses them (VolatileMemoryStore).

Contribution Checklist

@dmytrostruk dmytrostruk requested a review from a team as a code owner October 13, 2023 17:26
@dmytrostruk dmytrostruk self-assigned this Oct 13, 2023
@shawncal shawncal added the .NET Issue or Pull requests regarding .NET code label Oct 13, 2023
@dmytrostruk dmytrostruk added PR: ready for review All feedback addressed, ready for reviews PR: breaking change Pull requests that introduce breaking changes and removed .NET Issue or Pull requests regarding .NET code labels Oct 13, 2023
@shawncal shawncal added the .NET Issue or Pull requests regarding .NET code label Oct 13, 2023
@dmytrostruk dmytrostruk added this pull request to the merge queue Oct 16, 2023
Merged via the queue into microsoft:main with commit 224f0db Oct 16, 2023
18 checks passed
@dmytrostruk dmytrostruk deleted the hide-collection-types branch October 16, 2023 11:29
SOE-YoungS pushed a commit to SOE-YoungS/semantic-kernel that referenced this pull request Nov 1, 2023
…#3175)

### Motivation and Context

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

Resolves: microsoft#3152

This PR contains changes to make Memory Collection types as `internal`.
As alternative, developers can use
[PriorityQueue](https://learn.microsoft.com/en-us/dotnet/api/system.collections.generic.priorityqueue-2?view=net-7.0)
type, available in .NET 6, 7, 8.

### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->
1. Hide Memory Collection types.
2. Removed unit tests for hidden types, as they are covered with tests
for public type that uses them (`VolatileMemoryStore`).
### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [x] The code builds clean without any errors or warnings
- [x] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [x] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
.NET Issue or Pull requests regarding .NET code PR: breaking change Pull requests that introduce breaking changes PR: ready for review All feedback addressed, ready for reviews
Projects
None yet
Development

Successfully merging this pull request may close these issues.

.Net: MinHeap and TopNCollection should not be public
4 participants