Browse Source

added class docstrings

Fabian Peter Hammerle 4 years ago
parent
commit
762a858e4b
2 changed files with 34 additions and 2 deletions
  1. 3 2
      .pylintrc
  2. 31 0
      yamily/__init__.py

+ 3 - 2
.pylintrc

@@ -1,4 +1,5 @@
 [MESSAGES CONTROL]
 
-disable=bad-continuation,
-        missing-docstring
+disable=bad-continuation, # black
+        missing-module-docstring,
+        missing-function-docstring

+ 31 - 0
yamily/__init__.py

@@ -3,6 +3,21 @@ import typing
 
 
 class Person:
+
+    """
+    >>> alice = Person('alice')
+    >>> alice.name = 'Alice Test'
+    >>> alice.birth_date = datetime.date(2019, 12, 23)
+    >>> alice
+    Person(alice, Alice Test, *2019-12-23)
+    >>> str(alice)
+    'Alice Test (*2019-12-23)'
+
+    >>> bob = Person('bob')
+    >>> bob.name = 'Bob Test'
+    >>> alice.father = bob
+    """
+
     def __init__(self, identifier: str):
         self.identifier: str = identifier
         self.name: typing.Optional[str] = None
@@ -98,6 +113,22 @@ class Person:
 
 
 class PersonCollection:
+
+    """
+    >>> bob = Person('bob')
+    >>> bob.name = 'Bob Test'
+    >>> alice = Person('alice')
+    >>> alice.name = 'Alice Test'
+    >>> alice.father = bob
+    >>> collection = PersonCollection()
+    >>> collection.add_person(alice)
+    Person(alice, Alice Test)
+    >>> for person in collection:
+    ...     print(person.name)
+    Bob Test
+    Alice Test
+    """
+
     def __init__(self):
         self._persons = {}
         self.__it = None