Improving comments

Author: Jordan Mance

README.md

@@ -10,14 +10,14 @@ Demonstration & Walkthrough of how to use this library: https://github.com/mance
 ## Using figgy.lib
 
 This library greatly simplifies the process of fetching / using configurations from ParameterStore. It is designed
-to be used alongside the larger figgy ecosystem and will help you. For more details on why Figgy offers check out 
+to be used alongside the larger figgy ecosystem and will help you. For more details on what Figgy offers check out 
 the [Figgy Website.](https://www.figgy.dev)
 
 
 To the this lib to import parameters from parameter store:
 
 ### Define your configurations
-
+[What's a Fig?](https://www.figgy.dev/docs/getting-started/concepts.html)
 ```python
 
 # config.py
@@ -75,8 +75,8 @@ print(f"Found Merged SQL Connection String: {FIGS.SQL_CONNECTION_STRING}")
 
 ```
 
-If you run your APP and receive an error indicating a paramter is missing, run `figgy config sync --config figgy.json` where
-the `figgy.json`
+If you run your APP and receive an error indicating a parameter is missing, run `figgy config sync --config figgy.json` where
+the `figgy.json` is the path to the generated `figgy.json` file. 
 
 ### Override with ENV variables
 Any and all configurations can be overridden locally through ENV variables.

src/figgy/figs.py

@@ -91,6 +91,9 @@ def __str__(self):
 
 
 class AppFig(Fig):
+    """
+    Represents a single configuration that is specific to your application.
+    """
     default: Optional[str] = None
 
     def __init__(self, name: str, default: Optional[str] = None):
@@ -99,6 +102,10 @@ def __init__(self, name: str, default: Optional[str] = None):
 
 
 class ReplicatedFig(Fig):
+    """
+    Defines a parameter that is a global, shared, configuration that you want our application to have
+    access to in its FigStore.
+    """
     source: str
 
     def __init__(self, name: str, source: str):
@@ -107,11 +114,20 @@ def __init__(self, name: str, source: str):
 
 
 class SharedFig(Fig):
+    """
+    Defines a parameter owned by an outside party that must be shared with your application for it to run.
+
+    E.G - DB Credentials, API Keys, etc.
+    """
     def __init__(self, name: str):
         super().__init__(name=name)
 
 
 class MergeFig(Fig):
+    """
+    Creates a single parameter by combining a group of parameters into an "uber-parameter". This is ideal for
+    building out DB Connection URLs, etc.
+    """
     pattern: List[Union[str, Fig]]
 
     def __init__(self, name: str, pattern: List[Union[str, Fig]]):

src/figgy/writer.py

@@ -18,6 +18,13 @@ class ConfigWriter:
 
     @staticmethod
     def write(fig_store: FigStore, file_name: str = "figgy.json", destination_dir=""):
+        """
+        Writes a figgy-compatible declarative configuration file to disk.
+
+        @param: fig_store - A hydrated FigStore object used by your application to fetch configurations
+        @param: file_name - Default: `figgy.json` (recommended). The name of the file that will be written.
+        @param: destination_dir - Default: Current Directory..  The directory to write the `figgy.json` file to.
+        """
         destination_dir = destination_dir.rstrip("/")
 
         figgy_config: OrderedDict = OrderedDict()