refactor: Add docstrings and more comments and make minor edits to improve code readability (#27)

This PR adds documentation of all functions to explain their purposes
and what arguments are being passed around. It also adds more inline
comments to explain various different scenarios that might arise,
particularly around empty keys or various non-matching cases. Finally,
it includes some minor changes to the code that improve readability and
remove unnecessary operations.

BREAKING CHANGE: This PR changes the names of a few functions and
removes one unused one. This tag is also being used to demarcate our
intention to make our first major release when this PR is merged.

Author: vyasr

.gitignore

@@ -2,5 +2,7 @@ __pycache__
 .pytest_cache
 *.egg-info
 dist
+build
 tests/**/actual
 .vscode
+*.swp

src/rapids_dependency_file_generator/cli.py

@@ -52,8 +52,8 @@ def generate_matrix(matrix_arg):
         return {}
     matrix = {}
     for matrix_column in matrix_arg.split(";"):
-        kv_pair = matrix_column.split("=")
-        matrix[kv_pair[0]] = [kv_pair[1]]
+        key, val = matrix_column.split("=")
+        matrix[key] = [val]
     return matrix