docs update

carnival-org · Nov 24, 2021 · 68bda7d · 68bda7d
1 parent 7b33ec0
commit 68bda7d
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 0 deletions.
diff --git a/carnival/hosts/base.py b/carnival/hosts/base.py
@@ -79,6 +79,11 @@ class Host:
     Базовый класс для хостов
     """
 
+    addr: str
+    """
+    Адрес хоста
+    """
+
     def __init__(self, **context: typing.Any) -> None:
         """
         :param context: Контекст хоста

diff --git a/carnival/hosts/local.py b/carnival/hosts/local.py
@@ -45,6 +45,11 @@ class LocalHost(base.Host):
     Локальный хост, работает по локальному терминалу
     """
 
+    addr: str = "local"
+    """
+    Адрес хоста, всегда `local`
+    """
+
     def __init__(self, **context: typing.Any) -> None:
         """
         :param context: Контекст хоста

diff --git a/carnival/hosts/ssh.py b/carnival/hosts/ssh.py
@@ -71,6 +71,11 @@ class SshHost(base.Host):
     SSH хост
     """
 
+    addr: str
+    """
+    Домен либо ip хоста
+    """
+
     def __init__(
         self,
         addr: str,

diff --git a/docs/source/hosts.rst b/docs/source/hosts.rst
@@ -18,6 +18,7 @@
 
 .. autoclass:: carnival.hosts.local.LocalHost()
     :members:
+    :special-members: __init__
 
 .. autoclass:: carnival.hosts.local.LocalConnection()
     :members:
@@ -27,6 +28,7 @@ SSH
 
 .. autoclass:: carnival.hosts.ssh.SshHost()
     :members:
+    :special-members: __init__
 
 .. autoclass:: carnival.hosts.ssh.SshConnection()
     :members: