Fix doc-strings.

Author: hepheir

w3/__init__.py

@@ -1,5 +1,4 @@
 """A Python HTML Parser
-
 This is a personal project owned by Hepheir.
 
 https://github.com/Hepheir/Python-HTML-Parser/

w3/dom.py

@@ -1,5 +1,5 @@
-"""API Module of DOM - Level 1
-"""
+"""API Module of DOM - Level 1"""
+
 
 # Bring in subpackages.
 from w3.python.core import DOMException

w3/parser.py

@@ -1,2 +1 @@
-"""A Parser module for building Document Object Model Structure parsed from text/html.
-"""
+"""A Parser module for building Document Object Model Structure parsed from text/html."""

w3/python/__init__.py

@@ -1 +1,6 @@
+"""Imports core names of w3.
+
+Interfaces are implemented under "./core/"
+"""
+
 from w3.python import core

w3/python/core/__init__.py

@@ -1,5 +1,4 @@
-"""Module that contains classes of interfaces and ect.
-"""
+"""Module that contains classes of interfaces and ect."""
 
 from w3.python.core.fundamental_interface import DOMException
 from w3.python.core.fundamental_interface import DOMImplementation

w3/python/core/fundamental_interface/DOMImplementation.py

@@ -7,7 +7,6 @@ class DOMImplementation:
     """Interface DOMImplementation
 
     The `DOMImplementation` interface provides a number of methods for performing operations that are independent of any particular instance of the document object model.
-
     The DOM Level 1 does not specify a way of creating a document instance, and hence document creation is an operation specific to an implementation. Future Levels of the DOM specification are expected to provide methods for creating documents directly.
     """
 

w3/python/core/fundamental_interface/Node.py

@@ -103,13 +103,11 @@ def _check_modifiable(self) -> None:
 
     @property
     def node_name(self) -> DOMString:
-        """Read only; The name of this node, depending on its type.
-        """
+        """Read only; The name of this node, depending on its type."""
         return self._node_name
 
     def _set_node_name(self, name: DOMString) -> None:
-        """Indirect accessor to set the 'node_name' property.
-        """
+        """Indirect accessor to set the 'node_name' property."""
         self._node_name = DOMString(name)
 
     @property
@@ -139,67 +137,76 @@ def _set_node_value(self, value: DOMString) -> None:
 
     @property
     def node_type(self) -> NodeType:
-        """Read only; A code representing the type of the underlying object, as defined in `NodeType`.
-        """
+        """Read only; A code representing the type of the underlying object, as defined in `NodeType`."""
         return self._node_type
 
     def _set_node_type(self, node_type: NodeType) -> None:
-        """Indirect accessor to set the 'node_type' property.
-        """
+        """Indirect accessor to set the 'node_type' property."""
         if node_type not in NodeType:
             raise ValueError(f'{node_type} is not a valid code '
                              'for a node type.')
         self._node_type = node_type
 
     @property
     def parent_node(self) -> Optional[_AnyNode]:
-        """The parent of this node. All nodes, except `Document`, `DocumentFragment`, and `Attr` may have a parent. However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is `None`.
+        """The parent of this node.
+
+        All nodes, except `Document`, `DocumentFragment`, and `Attr` may have a parent.
+        However, if a node has just been created and not yet added to the tree, or if it has been removed from the tree, this is `None`.
         """
         return self._parent_node
 
     def _set_parent_node(self,
                          parent_node: Optional[_AnyNode]) -> None:
-        """Indirect accessor to set the 'node_type' property.
-        """
+        """Indirect accessor to set the 'node_type' property."""
         if not parent_node:
             self._parent_node = None
         else:
             self._parent_node = parent_node
 
     @property
     def child_nodes(self) -> NodeList:
-        """A `NodeList` that contains all children of this node. If there are no children, this is a `NodeList` containing no nodes. The content of the returned `NodeList` is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the `NodeList` accessors; it is not a static snapshot of the content of the node. This is true for every `NodeList`, including the ones returned by the `getElementsByTagName` method.
+        """A `NodeList` that contains all children of this node.
+
+        If there are no children, this is a `NodeList` containing no nodes.
+        The content of the returned `NodeList` is "live" in the sense that, for instance, changes to the children of the node object that it was created from are immediately reflected in the nodes returned by the `NodeList` accessors; it is not a static snapshot of the content of the node.
+        This is true for every `NodeList`, including the ones returned by the `getElementsByTagName` method.
         """
         return self._child_nodes
 
     def _init_child_nodes(self,
                           child_nodes: Optional[Iterable[_AnyNode]] = None) -> None:
-        """Accessor to set the 'child_nodes' property.
-        """
+        """Accessor to set the 'child_nodes' property."""
         if child_nodes is None:
             self._child_nodes = NodeList()
         else:
             self._child_nodes = NodeList(iter(child_nodes))
 
     @property
     def first_child(self) -> Optional[_AnyNode]:
-        """The first child of this node. If there is no such node, this returns `None`.
+        """The first child of this node.
+
+        If there is no such node, this returns `None`.
         """
         if not self.child_nodes:
             return None
         return self.child_nodes.item(0)
 
     @property
     def last_child(self) -> Optional[_AnyNode]:
-        """The last child of this node. If there is no such node, this returns `None`.
+        """The last child of this node.
+
+        If there is no such node, this returns `None`.
         """
         if not self.child_nodes:
             return None
         return self.child_nodes.item(self.child_nodes.length-1)
 
     @property
     def previous_sibling(self) -> Optional[_AnyNode]:
-        """The node immediately preceding this node. If there is no such node, this returns `None`.
+        """The node immediately preceding this node.
+
+        If there is no such node, this returns `None`.
         """
         if self.parent_node is None:
             return None
@@ -210,7 +217,9 @@ def previous_sibling(self) -> Optional[_AnyNode]:
 
     @property
     def next_sibling(self) -> Optional[_AnyNode]:
-        """The node immediately following this node. If there is no such node, this returns `None`.
+        """The node immediately following this node.
+
+        If there is no such node, this returns `None`.
         """
         if self.parent_node is None:
             return None
@@ -220,16 +229,17 @@ def next_sibling(self) -> Optional[_AnyNode]:
         return self.parent_node.child_nodes.item(nth_child+1)
 
     def _nth_child_of_parent(self) -> Optional[int]:
-        """Accessor that indicates how many siblings are there preceding this node. if there is no such parent node, this returns `None`.
+        """Accessor that indicates how many siblings are there preceding this node.
+
+        If there is no such parent node, this returns `None`.
         """
         if self.parent_node is None:
             return None
         return self.parent_node.child_nodes.index(self)
 
     @property
     def attributes(self) -> _NamedNodeMap:
-        """A `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `None` otherwise.
-        """
+        """A `NamedNodeMap` containing the attributes of this node (if it is an `Element`) or `None` otherwise."""
         return self._attributes
 
     def _init_attributes(self,
@@ -242,16 +252,18 @@ def _init_attributes(self,
 
     @property
     def owner_document(self) -> Optional[_Document]:
-        """The `Document` object associated with this node. This is also the `Document` object used to create new nodes. When this node is a `Document` this is `None`.
+        """The `Document` object associated with this node.
+
+        This is also the `Document` object used to create new nodes.
+        When this node is a `Document` this is `None`.
         """
         if self.node_type == NodeType.DOCUMENT_NODE:
             return None
         return self._owner_document
 
     def _set_owner_document(self,
                             owner_document: Optional[_Document] = None) -> None:
-        """Indirect accessor to set the 'owner_document' property.
-        """
+        """Indirect accessor to set the 'owner_document' property."""
         self._owner_document = owner_document
 
 

w3/python/core/fundamental_interface/NodeList.py

@@ -12,13 +12,17 @@ class NodeList(list):
 
     @property
     def length(self) -> int:
-        """The number of nodes in the list. The range of valid child node indices is 0 to `length`-1 inclusive.
+        """The number of nodes in the list.
+
+        The range of valid child node indices is 0 to `length`-1 inclusive.
         """
         return len(self)
 
 
     def item(self, index: int) -> Optional[_AnyNode]:
-        """Returns the indexth item in the collection. If index is greater than or equal to the number of nodes in the list, this returns null.
+        """Returns the indexth item in the collection.
+
+        If index is greater than or equal to the number of nodes in the list, this returns null.
 
         Args:
             index: Index into the collection.