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.

Sign up for GitHub

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

Jump to bottom

Python: Methods sharing the same description causing API reference documentation to fail #6254

Closed
kexugit opened this issue May 14, 2024 · 0 comments · Fixed by #6287
Closed

Python: Methods sharing the same description causing API reference documentation to fail #6254

kexugit opened this issue May 14, 2024 · 0 comments · Fixed by #6287
Labels
python Pull requests for the Python Semantic Kernel triage

Comments

@kexugit
Copy link

kexugit commented May 14, 2024

https://github.com/microsoft/semantic-kernel/blame/1692207639e68267cc06888a47016f84608a7cd1/python/semantic_kernel/functions/kernel_plugin.py#L66

Please see https://dev.azure.com/ceapex/Engineering/_workitems/edit/970595 for details.

@eavanvalkenburg
@markwallace-microsoft markwallace-microsoft added python Pull requests for the Python Semantic Kernel triage labels May 14, 2024
@github-actions github-actions bot changed the title Methods sharing the same description causing API reference documentation to fail Python: Methods sharing the same description causing API reference documentation to fail May 14, 2024
@eavanvalkenburg eavanvalkenburg mentioned this issue May 16, 2024
Merged
4 tasks
github-merge-queue bot pushed a commit that referenced this issue May 16, 2024
@eavanvalkenburg @moonbox3
Python: improved plugins docstrings (#6287)
2530367 
### 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.
-->
Fixes: #6254

### Description

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

### Contribution Checklist

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

- [ ] The code builds clean without any errors or warnings
- [ ] 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
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
bochris pushed a commit to bochris/semantic-kernel that referenced this issue May 16, 2024
@eavanvalkenburg @moonbox3 @bochris
Python: improved plugins docstrings (microsoft#6287)
7a5304b 
### 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.
-->
Fixes: microsoft#6254

### Description

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

### Contribution Checklist

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

- [ ] The code builds clean without any errors or warnings
- [ ] 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
- [ ] All unit tests pass, and I have added new tests where possible
- [ ] I didn't break anyone 😄

Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
python Pull requests for the Python Semantic Kernel triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Python: improved plugins docstrings eavanvalkenburg/semantic-kernel
2 participants
@kexugit @markwallace-microsoft