Skip to content

Fix docstrings for get_trait and expect_trait #401

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

Merged
merged 1 commit into from
Mar 4, 2025
Merged

Fix docstrings for get_trait and expect_trait #401

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
4 changes: 2 additions & 2 deletions packages/smithy-core/src/smithy_core/schemas.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ def get_trait[T: "Trait"](self, t: type[T]) -> T | None: ...
def get_trait(self, t: ShapeID) -> "Trait | DynamicTrait | None": ...

def get_trait(self, t: "type[Trait] | ShapeID") -> "Trait | DynamicTrait | None":
"""Get a trait based on it's ShapeID or class.
"""Get a trait based on its ShapeID or class.

:returns: A Trait if the trait class is known, a DynamicTrait if it isn't, or
None if the trait is not present on the Schema.
Expand All @@ -155,7 +155,7 @@ def expect_trait[T: "Trait"](self, t: type[T]) -> T: ...
def expect_trait(self, t: ShapeID) -> "Trait | DynamicTrait": ...

def expect_trait(self, t: "type[Trait] | ShapeID") -> "Trait | DynamicTrait":
"""Get a trait based on it's ShapeID or class.
"""Get a trait based on its ShapeID or class.

:returns: A Trait if the trait class is known, a DynamicTrait if it isn't.
"""
Expand Down
Loading