updated docstrings

avro/cli.py

@@ -77,7 +77,7 @@ def _cli_action(
 # usage: avro parse <text> [--bijoy] [--from-clip] [--copy]
 @cli.command("parse", help="Parse a given text to Bangla / Bengali.")
 @click.argument("text", required=False)
-@click.option("-b", "--bijoy", is_flag=True, help="Use Bijoy Keyboard format for parsing.")
+@click.option("-b", "--bijoy", is_flag=True, help="Use Bijoy Keyboard (ASCII) format for parsing.")
 @click.option("-i", "--ignore-remap", is_flag=True, help="Ignore remapping of predefined words.")
 @click.option("-f", "--from-clip", is_flag=True, help="Parse text from clipboard.")
 @click.option("-c", "--copy", is_flag=True, help="Copy the parsed text to clipboard.")

avro/config.py

@@ -10,13 +10,13 @@
 AVRO_CASESENSITIVES = set(DICT["avro"]["casesensitive"])
 AVRO_NUMBERS = set(DICT["avro"]["number"])
 
-# Shortcuts to Bengali Svaravarna, Kar(s)
+# Shortcuts to Bengali Svaravarna, Kar(s).
 AVRO_SHORBORNO = set(DICT["avro"]["shorborno"])
 AVRO_KAR = set(DICT["avro"]["kar"])
 AVRO_IGNORE = set(DICT["avro"]["ignore"])
 AVRO_EXCEPTIONS = DICT["avro"]["exceptions"]
 
-# Shortcuts for conversion (e.g. for Bijoy Keyboard support).
+# Shortcuts for conversion to Bijoy Keyboard format (ASCII).
 BIJOY_MAP = DICT["bijoy"]["mappings"]
 BIJOY_PREKAR = set(DICT["bijoy"]["prekar"])
 BIJOY_BANJONBORNO = set(DICT["bijoy"]["banjonborno"])

avro/main.py

@@ -117,7 +117,7 @@ def output_generator() -> Generator[str, None, None]:
 
 def to_bijoy(*texts: str) -> Union[str, List[str]]:
     """
-    #### Converts input text to Bijoy Keyboard format.
+    #### Converts input text to Bijoy Keyboard format (ASCII).
 
     If a valid conversion is found, then it returns the converted string.