From e9d228ba2c556822a946a146952312e719a13cd7 Mon Sep 17 00:00:00 2001 From: Marc Beninca Date: Tue, 17 Sep 2024 22:17:41 +0200 Subject: [PATCH] doc/os --- rwx/os/__init__.py | 7 ++++++- rwx/os/abstract.py | 11 +++++++++-- 2 files changed, 15 insertions(+), 3 deletions(-) diff --git a/rwx/os/__init__.py b/rwx/os/__init__.py index 75a0bc9..27c1748 100644 --- a/rwx/os/__init__.py +++ b/rwx/os/__init__.py @@ -8,7 +8,12 @@ from .debian import Debian def from_path(path: Path) -> OS: - """Initialize from an already existing path.""" + """Initialize from an already existing path. + + :param path: source root directory + :type path: Path + :rtype: OS + """ return Debian(path) diff --git a/rwx/os/abstract.py b/rwx/os/abstract.py index f4837fc..77f9cb1 100644 --- a/rwx/os/abstract.py +++ b/rwx/os/abstract.py @@ -10,10 +10,17 @@ class OS(Class, ABC): """Operating System.""" def __init__(self, path: Path) -> None: - """Set root.""" + """Set root. + + :param path: root directory + :type path: Path + """ self.root = path self.name = self.get_name() @abstractmethod def get_name(self) -> str: - """Return mandatory name.""" + """Return mandatory name. + + :rtype: str + """