Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
victordibia committed Jan 26, 2025
1 parent 0f7ce2c commit 6760d07
Showing 1 changed file with 1 addition and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ class ComponentToConfig(Generic[ToConfigT]):
component_provider_override: ClassVar[str | None] = None
"""Override the provider string for the component. This should be used to prevent internal module names being a part of the module name."""
component_description: ClassVar[str | None] = None
"""A description of the component."""
"""A description of the component. If not provided, the docstring of the class will be used."""

def _to_config(self) -> ToConfigT:
"""Dump the configuration that would be requite to create a new instance of a component matching the configuration of this instance.
Expand Down

0 comments on commit 6760d07

Please sign in to comment.