Update docs

hdadhich01 · Dec 14, 2023 · bb7b66d · bb7b66d
1 parent 711dbdf
commit bb7b66d
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -32,7 +32,7 @@ from round_nutrition import * # or specific functions
 All subnutrient functions take in an `int` or `str` argument for `quantity`
 
 ```js
-         General ‎                   Vitamin ‎                  Mineral ‎                  Other ‎
+         General                   Vitamin                  Mineral                  Other
       added_sugars*           biotin                      calcium                   choline
       calories                folate                      chromium
       cholesterol*            niacin                      copper

diff --git a/round_nutrition/general.py b/round_nutrition/general.py
@@ -173,7 +173,7 @@ def soluble_fiber(quantity: "int|str", minimal: bool = False) -> str:
 
 
 def insoluble_fiber(quantity: "int|str", minimal: bool = False) -> str:
-    """Round a insoluble fiber quantity.
+    """Round an insoluble fiber quantity.
 
     Args:
         quantity (int|str): The quantity to be rounded.
@@ -205,7 +205,7 @@ def total_sugars(quantity: "int|str", minimal: bool = False) -> str:
 
 
 def added_sugars(quantity: "int|str", minimal: bool = False) -> str:
-    """Round a added sugars quantity.
+    """Round an added sugars quantity.
 
     Args:
         quantity (int|str): The quantity to be rounded.
@@ -237,7 +237,7 @@ def sugar_alcohol(quantity: "int|str", minimal: bool = False) -> str:
 
 
 def other_carb(quantity: "int|str", minimal: bool = False) -> str:
-    """Round a other carbohydrate quantity.
+    """Round an other carbohydrate quantity.
 
     Args:
         quantity (int|str): The quantity to be rounded.

diff --git a/round_nutrition/mineral.py b/round_nutrition/mineral.py
@@ -50,7 +50,7 @@ def magnesium(quantity: "int|str") -> str:
 
 
 def iron(quantity: "int|str") -> str:
-    """Round a iron quantity.
+    """Round an iron quantity.
 
     Args:
         quantity (int|str): The quantity to be rounded.