update object module docs

Author: bygu4

pyformlang/objects/base_epsilon.py

@@ -1,4 +1,4 @@
-""" General epsilon representation """
+"""General epsilon representation."""
 
 from typing import Any
 
@@ -9,26 +9,28 @@
 
 
 class BaseEpsilon(BaseTerminal):
-    """ An epsilon transition
+    """An epsilon transition.
 
     Examples
     --------
-
     >>> epsilon = Epsilon()
-
     """
 
     def __init__(self) -> None:
+        """Initializes the epsilon terminal."""
         super().__init__("epsilon")
 
     def __eq__(self, other: Any) -> bool:
+        """Check if the epsilon is equal to the given object."""
         return isinstance(other, BaseEpsilon) \
             or not isinstance(other, FormalObject) and other in EPSILON_SYMBOLS
 
     def __hash__(self) -> int:
+        """Gets the hash of the epsilon symbol."""
         return super().__hash__()
 
     def __repr__(self) -> str:
+        """Gets the string representation of the epsilon symbol."""
         return "epsilon"
 
     def _is_equal_to(self, other: FormalObject) -> bool:

pyformlang/objects/base_terminal.py

@@ -1,15 +1,16 @@
-""" General terminal representation """
+"""General terminal representation."""
 
 from abc import abstractmethod
 
 from .formal_object import FormalObject
 
 
 class BaseTerminal(FormalObject):
-    """ General terminal representation """
+    """General terminal representation."""
 
     @abstractmethod
     def __repr__(self):
+        """Gets the string representation of the terminal."""
         raise NotImplementedError
 
     def _is_equal_to(self, other: FormalObject) -> bool:

pyformlang/objects/cfg_objects/cfg_object.py

@@ -1,20 +1,20 @@
-""" An object in a CFG (Variable and Terminal)"""
+"""An object in a CFG (Variable and Terminal)."""
 
 from abc import abstractmethod
 
 from ..formal_object import FormalObject
 
 
 class CFGObject(FormalObject):
-    """ An object in a CFG
+    """An object in a CFG.
 
     Parameters
     -----------
-    value : any
-        The value of the object
+    value:
+        The value of the object.
     """
 
     @abstractmethod
     def to_text(self) -> str:
-        """ Turns the object into a text format """
+        """Turns the object into a text format."""
         raise NotImplementedError

pyformlang/objects/cfg_objects/epsilon.py

@@ -1,8 +1,8 @@
-""" An epsilon terminal """
+"""An epsilon terminal in CFG."""
 
 from .terminal import Terminal
 from ..base_epsilon import BaseEpsilon
 
 
 class Epsilon(BaseEpsilon, Terminal):
-    """ An epsilon terminal """
+    """An epsilon terminal in CFG."""

pyformlang/objects/cfg_objects/production.py

@@ -1,4 +1,4 @@
-""" A production or rule of a CFG """
+"""A production or rule of a CFG."""
 
 from typing import List, Set, Any
 
@@ -9,14 +9,14 @@
 
 
 class Production:
-    """ A production or rule of a CFG
+    """A production or rule of a CFG.
 
     Parameters
     ----------
-    head : :class:`~pyformlang.cfg.Variable`
-        The head of the production
-    body : iterable of :class:`~pyformlang.cfg.CFGObject`
-        The body of the production
+    head:
+        The head of the production.
+    body:
+        The body of the production.
     """
 
     __slots__ = ["_body", "_head", "_hash"]
@@ -25,6 +25,7 @@ def __init__(self,
                  head: Variable,
                  body: List[CFGObject],
                  filtering: bool = True) -> None:
+        """Initializes the production."""
         if filtering:
             self._body = [x for x in body if not isinstance(x, Epsilon)]
         else:
@@ -34,48 +35,48 @@ def __init__(self,
 
     @property
     def head(self) -> Variable:
-        """Gets the head variable"""
+        """Gets the head variable of the production."""
         return self._head
 
     @property
     def body(self) -> List[CFGObject]:
-        """Gets the body objects"""
+        """Gets the body objects of the production."""
         return self._body
 
     @property
     def variables(self) -> Set[Variable]:
-        """Gets variables used in the production"""
+        """Gets variables used in the production."""
         return {self.head} | {object for object in self.body
                               if isinstance(object, Variable)}
 
     @property
     def terminals(self) -> Set[Terminal]:
-        """Gets terminals used in the production"""
+        """Gets terminals used in the production."""
         return {object for object in self.body
                 if isinstance(object, Terminal) and object != Epsilon()}
 
     def __eq__(self, other: Any) -> bool:
+        """Checks if current production is equal to the given object."""
         if not isinstance(other, Production):
             return False
         return self.head == other.head and self.body == other.body
 
     def __hash__(self) -> int:
+        """Gets the hash of the production."""
         if self._hash is None:
             self._hash = sum(map(hash, self._body)) + hash(self._head)
         return self._hash
 
     def __repr__(self) -> str:
+        """Gets the string representation of the production."""
         return str(self.head) + " -> " + " ".join([str(x) for x in self.body])
 
     def is_normal_form(self) -> bool:
-        """
-        Tells is the production is in Chomsky Normal Form
+        """Tells if the production is in Chomsky Normal Form.
 
         Returns
         -------
-        is_normal_form : bool
-            If the production is in CNF
-
+        Whether the production is in CNF.
         """
         if len(self._body) == 2:
             return (isinstance(self._body[0], Variable) and

pyformlang/objects/cfg_objects/terminal.py

@@ -1,16 +1,24 @@
-""" A terminal in a CFG """
+"""A terminal in a CFG."""
 
 from .cfg_object import CFGObject
 from ..base_terminal import BaseTerminal
 
 
 class Terminal(BaseTerminal, CFGObject):
-    """ A terminal in a CFG """
+    """A terminal in a CFG.
+
+    Parameters
+    ----------
+    value:
+        A value of the terminal.
+    """
 
     def __repr__(self) -> str:
+        """Gets the string representation of the terminal."""
         return f"Terminal({self})"
 
     def to_text(self) -> str:
+        """Gets a formatted string representing the terminal."""
         text = str(self._value)
         if text and text[0].isupper():
             return '"TER:' + text + '"'

pyformlang/objects/cfg_objects/utils.py

@@ -1,4 +1,4 @@
-""" Utility for cfg object creation """
+"""Utility for CFG object creation."""
 
 from typing import Hashable
 
@@ -8,14 +8,14 @@
 
 
 def to_variable(given: Hashable) -> Variable:
-    """ Transformation into a variable """
+    """Transforms the given object into a variable."""
     if isinstance(given, Variable):
         return given
     return Variable(given)
 
 
 def to_terminal(given: Hashable) -> Terminal:
-    """ Transformation into a terminal """
+    """Transforms the given object into a terminal."""
     if given == Epsilon():
         return Epsilon()
     if isinstance(given, Terminal):

pyformlang/objects/cfg_objects/variable.py

@@ -1,4 +1,4 @@
-""" A variable in a CFG """
+"""A variable in a CFG."""
 
 from string import ascii_uppercase
 
@@ -7,18 +7,20 @@
 
 
 class Variable(CFGObject):
-    """ An variable in a CFG
+    """An variable in a CFG.
 
     Parameters
     -----------
-    value : any
-        The value of the variable
+    value:
+        The value of the variable.
     """
 
     def __repr__(self) -> str:
+        """Gets the string representation of the variable."""
         return f"Variable({self})"
 
     def to_text(self) -> str:
+        """Gets a formatted string representing the variable."""
         text = str(self._value)
         if text and text[0] not in ascii_uppercase:
             return '"VAR:' + text + '"'

pyformlang/objects/finite_automaton_objects/epsilon.py

@@ -1,17 +1,13 @@
-"""
-Represents an epsilon transition
-"""
+"""An epsilon symbol in finite automaton."""
 
 from .symbol import Symbol
 from ..base_epsilon import BaseEpsilon
 
 
 class Epsilon(BaseEpsilon, Symbol):
-    """ An epsilon transition
+    """An epsilon symbol in finite automaton.
 
     Examples
     --------
-
     >>> epsilon = Epsilon()
-
     """

pyformlang/objects/finite_automaton_objects/finite_automaton_object.py

@@ -1,21 +1,20 @@
-"""
-Represents an object of a finite state automaton
-"""
+"""Representation of an object of a finite state automaton."""
 
 from abc import abstractmethod
 
 from ..formal_object import FormalObject
 
 
 class FiniteAutomatonObject(FormalObject):
-    """ Represents an object in a finite state automaton
+    """Representation of an object of a finite state automaton.
 
     Parameters
     ----------
-    value: any
-        The value of the object
+    value:
+        The value of the object.
     """
 
     @abstractmethod
     def __repr__(self) -> str:
+        """Gets a string representation of the object."""
         raise NotImplementedError