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

feat:Title: Update documentation for API endpoints and usage examples #54

Merged
merged 1 commit into from
Sep 22, 2024
Merged

feat:Title: Update documentation for API endpoints and usage examples #54

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/libs/Anthropic/Generated/Anthropic.Models.StopReason.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,15 @@ namespace Anthropic
public enum StopReason
{
/// <summary>
///
/// the model reached a natural stopping point
/// </summary>
EndTurn,
/// <summary>
///
/// we exceeded the requested `max_tokens` or the model's maximum
/// </summary>
MaxTokens,
/// <summary>
///
/// one of your provided custom `stop_sequences` was generated
/// </summary>
StopSequence,
/// <summary>
Expand Down
6 changes: 3 additions & 3 deletions src/libs/Anthropic/Generated/Anthropic.Models.ToolChoiceType.g.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ namespace Anthropic
public enum ToolChoiceType
{
/// <summary>
///
/// allows Claude to decide whether to call any provided tools or not. This is the default value.
/// </summary>
Auto,
Comment on lines +16 to 18
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Improve consistency and clarity in enum member documentation.

The current documentation for Auto is inconsistent with the enum-level documentation and doesn't provide additional value. Consider the following suggestions:

  1. Align the documentation with the enum-level description.
  2. Remove redundant information about being the default value, as it's already mentioned in the enum-level documentation.

Here's a suggested improvement:

- /// allows Claude to decide whether to call any provided tools or not. This is the default value.
+ /// Allows Claude to decide whether to call any provided tools or not.

This change maintains consistency with the enum-level documentation while avoiding redundancy.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
/// allows Claude to decide whether to call any provided tools or not. This is the default value.
/// </summary>
Auto,
/// Allows Claude to decide whether to call any provided tools or not.
/// </summary>
Auto,

/// <summary>
///
/// allows Claude to decide whether to call any provided tools or not. This is the default value.
/// </summary>
Any,
Comment on lines +20 to 22
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the documentation for Any enum member.

The current documentation for Any is incorrect and inconsistent with the enum-level documentation. It appears to be a copy of the Auto member's documentation.

Please replace the current documentation with the correct description:

- /// allows Claude to decide whether to call any provided tools or not. This is the default value.
+ /// Tells Claude that it must use one of the provided tools, but doesn't force a particular tool.

This change aligns the member-level documentation with the enum-level description, providing accurate information about the Any option.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
/// allows Claude to decide whether to call any provided tools or not. This is the default value.
/// </summary>
Any,
/// Tells Claude that it must use one of the provided tools, but doesn't force a particular tool.
/// </summary>
Any,

/// <summary>
///
/// allows Claude to decide whether to call any provided tools or not. This is the default value.
/// </summary>
Tool,
Comment on lines +24 to 26
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the documentation for Tool enum member.

The current documentation for Tool is incorrect and inconsistent with the enum-level documentation. It appears to be a copy of the Auto member's documentation.

Please replace the current documentation with the correct description:

- /// allows Claude to decide whether to call any provided tools or not. This is the default value.
+ /// Allows us to force Claude to always use a particular tool specified in the `name` field.

This change aligns the member-level documentation with the enum-level description, providing accurate information about the Tool option.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
/// allows Claude to decide whether to call any provided tools or not. This is the default value.
/// </summary>
Tool,
/// Allows us to force Claude to always use a particular tool specified in the `name` field.
/// </summary>
Tool,

}
Expand Down