Python: Small docstring fix #5741
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Small fix to docstring to conform to standards.
markwallace-microsoft
added
the
python
Python 3.8 Test Coverage Report •
Python 3.8 Unit Test Overview
|
moonbox3
approved these changes
Apr 2, 2024
eavanvalkenburg
approved these changes
Apr 3, 2024
LudoCorporateShark
pushed a commit
to LudoCorporateShark/semantic-kernel
that referenced
this pull request
Aug 25, 2024
### Motivation and Context This is a single-line fix to a Python docstring to get it to conform to Sphinx standards and convention used [elsewhere](https://github.com/microsoft/semantic-kernel/blob/20304f38fed9730f258acbdf59bad898ac809952/python/semantic_kernel/planners/plan.py#L137) in the project. (My team owns the reference docs generation process for this and other libraries. We forced a build the other day from our side for test purposes and noticed it stumbled over this line. Feel free to ping me if any questions.) ### Description See changes, it's a one-liner 😁 ### Contribution Checklist I ashamedly admit I have done *none* of the below; hopefully this is a gimme, apologies if it creates noise. - [ ] 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 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
This is a single-line fix to a Python docstring to get it to conform to Sphinx standards and convention used elsewhere in the project.
(My team owns the reference docs generation process for this and other libraries. We forced a build the other day from our side for test purposes and noticed it stumbled over this line. Feel free to ping me if any questions.)
Description
See changes, it's a one-liner 😁
Contribution Checklist
I ashamedly admit I have done none of the below; hopefully this is a gimme, apologies if it creates noise.