Add type hints, rearrange doc-strings and comments

Author: poyea

graphs/dfs.py

@@ -1,25 +1,33 @@
-"""pseudo-code"""
+"""The DFS function simply calls itself recursively for every unvisited child of 
+its argument. We can emulate that behaviour precisely using a stack of iterators. 
+Instead of recursively calling with a node, we'll push an iterator to the node's 
+children onto the iterator stack. When the iterator at the top of the stack
+terminates, we'll pop it off the stack.
 
+Pseudocode:
+    all nodes initially unexplored
+    mark s as explored
+    for every edge (s, v):
+        if v unexplored:
+            DFS(G, v)
 """
-DFS(graph G, start vertex s):
-// all nodes initially unexplored
-mark s as explored
-for every edge (s, v):
-    if v unexplored:
-        DFS(G, v)
-"""
 
+from typing import Set, Dict
+
+
+def dfs(graph: Dict, start: str) -> Set[int]:
+    """Depth First Search on Graph
 
-def dfs(graph, start):
-    """The DFS function simply calls itself recursively for every unvisited child of its argument. We can emulate that
-     behaviour precisely using a stack of iterators. Instead of recursively calling with a node, we'll push an iterator
-      to the node's children onto the iterator stack. When the iterator at the top of the stack terminates, we'll pop
-       it off the stack."""
+       :param graph: directed graph in dictionary format
+       :param vertex: starting vectex as a string
+       :returns: the trace of the search
+    """
     explored, stack = set(start), [start]
     while stack:
         v = (
             stack.pop()
-        )  # one difference from BFS is to pop last element here instead of first one
+        )
+        # one difference from BFS is to pop last element here instead of first one
         for w in graph[v]:
             if w not in explored:
                 explored.add(w)
@@ -36,4 +44,5 @@ def dfs(graph, start):
     "F": ["C", "E"],
 }
 
-print(dfs(G, "A"))
+if __name__ == "__main__":
+    print(dfs(G, "A"))