Skip to content

Improve docstring for code-generated Config object#595

Merged
jonathan343 merged 1 commit intodevelopfrom
fix-config-docstring
Nov 4, 2025
Merged

Improve docstring for code-generated Config object#595
jonathan343 merged 1 commit intodevelopfrom
fix-config-docstring

Conversation

@jonathan343
Copy link
Contributor

Summary

This PR improves the docstring for code-generated Config objects for AWS service clients.

We currently use the name of the smithy service type and will instead try to use the sdkId.

Examples

Bedrock Runtime

Before:

class Config:
    """Configuration for AmazonBedrockFrontendService."""

After:

class Config:
    """Configuration for Bedrock Runtime."""

Transcribe Streaming

Before:

class Config:
    """Configuration for Transcribe."""

After:

class Config:
    """Configuration for Transcribe Streaming."""

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jonathan343 jonathan343 merged commit ee6ce70 into develop Nov 4, 2025
6 checks passed
@jonathan343 jonathan343 deleted the fix-config-docstring branch November 4, 2025 15:47
SamRemis pushed a commit to SamRemis/smithy-python that referenced this pull request Nov 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants