Repository navigation
Use service titles in client package descriptions - #930
Closed
jonathan343 wants to merge 3 commits into
Closed
jonathan343 wants to merge 3 commits into
jonathan343 wants to merge 3 commits into
Conversation
Default client descriptions to the service title, with the service name as a fallback. Share the resolved description between package metadata and the README while preserving explicit overrides and types defaults.
jonathan343
commented
Nov 12, 2026
Contributor
Author
There was a problem hiding this comment.
Note: We should do a complete rehaul of the generated READMEs in a separate PR. This just improves what is there now since the description is already being used there.
Limit title-based descriptions to pyproject.toml metadata. Preserve the existing README output for a separate documentation overhaul.
Resolve descriptions during setup generation, honoring overrides before service titles and names. Use the module name for service-less types packages, and share the result between metadata and README output.
This file contains hidden or 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
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.
Summary
Generated client descriptions currently repeat the module name, such as
aws_sdk_dynamodb client, rather than identifying the service in readable terms.This PR uses the service's standard
smithy.api#titletrait to generatePython client for <title>orPython types for <title>, falling back to theservice shape's name when no title is present. Types packages generated without
a selected service use the module name instead of the internal synthetic service
name. This works for AWS and non-AWS services. Package metadata and the generated
README share the same resolved description. Explicit
moduleDescriptionoverrides are unchanged.
Example
For Amazon DynamoDB, the generated
pyproject.tomlchanges from:To:
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.