docs(views): fix flake8 warnings

Author: yt-ms

src/structurizr/view/animation.py

@@ -68,6 +68,7 @@ def __init__(
 
     @classmethod
     def hydrate(cls, animation_io: AnimationIO) -> "Animation":
+        """Hydrate a new Animation instance from its IO."""
         return cls(
             order=animation_io.order,
             elements=animation_io.elements,

src/structurizr/view/automatic_layout.py

@@ -27,12 +27,7 @@
 
 
 class AutomaticLayoutIO(BaseModel):
-    """
-    Define a wrapper for automatic layout configuration.
-
-    Attributes:
-
-    """
+    """Define a wrapper for automatic layout configuration."""
 
     rank_direction: RankDirection = Field(..., alias="rankDirection")
     rank_separation: int = Field(..., alias="rankSeparation")
@@ -42,12 +37,7 @@ class AutomaticLayoutIO(BaseModel):
 
 
 class AutomaticLayout(AbstractBase):
-    """
-    Define a wrapper for automatic layout configuration.
-
-    Attributes:
-
-    """
+    """Define a wrapper for automatic layout configuration."""
 
     def __init__(
         self,
@@ -69,6 +59,7 @@ def __init__(
 
     @classmethod
     def hydrate(cls, automatic_layout_io: AutomaticLayoutIO) -> "AutomaticLayout":
+        """Hydrate a new AutomaticLayout instance from its IO."""
         return cls(
             rank_direction=automatic_layout_io.rank_direction,
             rank_separation=automatic_layout_io.rank_separation,

src/structurizr/view/branding.py

@@ -27,24 +27,14 @@
 
 
 class BrandingIO(BaseModel):
-    """
-    Represent an instance of a corporate branding.
-
-    Attributes:
-
-    """
+    """Represent an instance of a corporate branding."""
 
     logo: Optional[str]
     font: Optional[FontIO]
 
 
 class Branding(AbstractBase):
-    """
-    Represent a corporate branding.
-
-    Attributes:
-
-    """
+    """Represent a corporate branding."""
 
     def __init__(
         self, *, logo: Optional[str] = None, font: Optional[Font] = None, **kwargs

src/structurizr/view/component_view.py

@@ -75,7 +75,7 @@ def hydrate(
         component_view_io: ComponentViewIO,
         container: Container,
     ) -> "ComponentView":
-        """"""
+        """Hydrate a new ComponentView instance from its IO."""
         return cls(
             **cls.hydrate_arguments(component_view_io),
             container=container,
@@ -86,6 +86,7 @@ def hydrate(
 
     @property
     def name(self):
+        """Return the (computed) name of this view."""
         return f"{self.software_system.name} - {self.container.name} - Components"
 
     def add(
@@ -103,6 +104,7 @@ def add(
         return self._add_element(element, add_relationships=True)
 
     def remove(self, element):
+        """Remove an individual element from this view."""
         self._remove_element(element)
 
     def add_all_elements(self) -> None:
@@ -113,14 +115,17 @@ def add_all_elements(self) -> None:
         self.add_all_components()
 
     def add_all_containers(self) -> None:
+        """Add all other containers in the software system to this view."""
         for container in self.software_system.containers:
             self.add(container)
 
     def add_all_components(self) -> None:
+        """Add all components in the container to this view."""
         for component in self.container.components:
             self.add(component)
 
     def add_nearest_neighbours(self, element: Element, _=None) -> None:
+        """Add neighbouring people, software systems, containers and components."""
         super().add_nearest_neighbours(element, SoftwareSystem)
         super().add_nearest_neighbours(element, Person)
         super().add_nearest_neighbours(element, Container)

src/structurizr/view/configuration.py

@@ -32,12 +32,7 @@
 
 
 class ConfigurationIO(BaseModel):
-    """
-    Represent a configuration instance.
-
-    Attributes:
-
-    """
+    """Represent a configuration instance."""
 
     branding: Optional[BrandingIO]
     styles: Optional[StylesIO]
@@ -52,12 +47,7 @@ class ConfigurationIO(BaseModel):
 
 
 class Configuration(AbstractBase):
-    """
-    Configure how information in a workspace is rendered.
-
-    Attributes:
-
-    """
+    """Configure how information in a workspace is rendered."""
 
     def __init__(
         self,
@@ -83,7 +73,7 @@ def __init__(
 
     @classmethod
     def hydrate(cls, configuration_io: ConfigurationIO) -> "Configuration":
-        """"""
+        """Hydrate new Configuration instance from its IO."""
         return cls(
             # TODO:
             # branding=Branding.hydrate(configuration_io.branding),

src/structurizr/view/container_view.py

@@ -67,7 +67,7 @@ def hydrate(
         container_view_io: ContainerViewIO,
         software_system: SoftwareSystem,
     ) -> "ContainerView":
-        """"""
+        """Hydrate a new ContainerView instance from its IO."""
         return cls(
             **cls.hydrate_arguments(container_view_io),
             software_system=software_system,
@@ -99,10 +99,12 @@ def add_all_elements(self) -> None:
         self.add_all_containers()
 
     def add_all_containers(self) -> None:
+        """Add all containers within the software system in scope to this view."""
         for container in self.software_system.containers:
             self.add(container)
 
     def add_nearest_neighbours(self, element: Element, _=None) -> None:
+        """Add all people, software systems and containers that neighbor an element."""
         super().add_nearest_neighbours(element, SoftwareSystem)
         super().add_nearest_neighbours(element, Person)
         super().add_nearest_neighbours(element, Container)