Skip to content

Commit

Permalink
.Net: Minor Documentation Corrections in MathPlugin: (#3657)
Browse files Browse the repository at this point in the history
- Corrected the summary comment of the Subtract method to accurately
reflect its subtraction functionality.
- Added a point and fixed capitalization in the summary comment of the
Add method.

These changes improve the consistency and accuracy of the documentation
in MathPlugin.

### 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.
-->

### 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: -->

- [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: SergeyMenshykh <68852919+SergeyMenshykh@users.noreply.github.com>
  • Loading branch information
slimktari and SergeyMenshykh committed Dec 14, 2023
1 parent 49a1cb8 commit 1226b62
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions dotnet/src/Plugins/Plugins.Core/MathPlugin.cs
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ namespace Microsoft.SemanticKernel.Plugins.Core;
public sealed class MathPlugin
{
/// <summary>
/// Returns the Addition result of initial and amount values provided.
/// Returns the addition result of initial and amount values provided.
/// </summary>
/// <param name="value">Initial value to which to add the specified amount</param>
/// <param name="value">Initial value to which to add the specified amount.</param>
/// <param name="amount">The amount to add as a string.</param>
/// <returns>The resulting sum as a string.</returns>
[KernelFunction, Description("Adds an amount to a value")]
Expand All @@ -23,9 +23,9 @@ public sealed class MathPlugin
value + amount;

/// <summary>
/// Returns the Sum of two provided numbers.
/// Returns the subtraction result of initial and amount values provided.
/// </summary>
/// <param name="value">Initial value from which to subtract the specified amount</param>
/// <param name="value">Initial value from which to subtract the specified amount.</param>
/// <param name="amount">The amount to subtract as a string.</param>
/// <returns>The resulting subtraction as a string.</returns>
[KernelFunction, Description("Subtracts an amount from a value")]
Expand Down

0 comments on commit 1226b62

Please sign in to comment.