Update clients to support Google-style docstrings. #24
Conversation
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
arandito
requested review from
SamRemis,
alexgromero and
jonathan343
and removed request for
SamRemis
arandito
changed the title
arandito
changed the base branch from
develop
to
feat/migrate-sphinx-to-mkdocs
arandito
changed the title
jonathan343
approved these changes
Dec 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
This PR updates updates the docstring format from RST to Google style with Markdown descriptions.
Important
The client was generated using the changes introduced in smithy-lang/smithy-python#592. The new docstring format enables us to generate documentation using Material for MkDocs. In a future PR, we will add a script to generate MkDocs stubs that work with the mkdocstrings tool. This will automatically create documentation from docstrings for all clients.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.