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

Python: documentation for /memory #2176

Merged
merged 9 commits into from
Jul 27, 2023
Merged

Conversation

sneha-afk
Copy link
Contributor

Description

Added documentation for files in python/semantic-kernel/memory that were missing them, worded mostly the exact as in .NET

Closes #2141

Contribution Checklist

@sneha-afk sneha-afk requested a review from a team as a code owner July 25, 2023 18:18
@shawncal shawncal added the python Pull requests for the Python Semantic Kernel label Jul 25, 2023
@sneha-afk sneha-afk changed the title Mem docs Python: documenation for /memory Jul 25, 2023
@shawncal shawncal changed the title Python: documenation for /memory Python: Mem docs Jul 25, 2023
@sneha-afk sneha-afk changed the title Python: Mem docs Python: documenation for /memory Jul 25, 2023
@glahaye glahaye changed the title Python: documenation for /memory Python: documentation for /memory Jul 27, 2023
@sneha-afk
Copy link
Contributor Author

I deleted some comments that indicated a None value being returned, like in get_nearest_match_async and get_async, because the implementation of these methods is inconsistent across the connectors. Some throw errors while others return None.

Perhaps a consensus should be reached about this behavior? The C# inline docs for these functions indicate null values.

@sneha-afk sneha-afk requested a review from glahaye July 27, 2023 05:06
@glahaye glahaye added the PR: ready to merge PR has been approved by all reviewers, and is ready to merge. label Jul 27, 2023
@awharrison-28 awharrison-28 added this pull request to the merge queue Jul 27, 2023
Merged via the queue into microsoft:main with commit e687301 Jul 27, 2023
20 checks passed
@sneha-afk sneha-afk deleted the mem-docs branch August 26, 2023 19:51
SOE-YoungS pushed a commit to SOE-YoungS/semantic-kernel that referenced this pull request Nov 1, 2023
### Description

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

Added documentation for files in `python/semantic-kernel/memory` that
were missing them, worded mostly the exact as in .NET

Closes microsoft#2141 

### 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
- [X] I didn't break anyone 😄

---------

Co-authored-by: Abby Harrison <54643756+awharrison-28@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: ready to merge PR has been approved by all reviewers, and is ready to merge. python Pull requests for the Python Semantic Kernel
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add in-line documentation for files under semantic-kernel/memory
4 participants