More documentation

noamgat · May 4, 2024 · e00409c · e00409c
1 parent eb86c7d
commit e00409c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lmformatenforcer/characterlevelparser.py b/lmformatenforcer/characterlevelparser.py
@@ -24,8 +24,11 @@ class CharacterLevelParserConfig:
     alphabet: str = COMPLETE_ALPHABET
     max_consecutive_whitespaces: int = _env_or_default_field(CONFIG_ENV_VAR_MAX_CONSECUTIVE_WHITESPACES, 
                                                              DEFAULT_MAX_CONSECUTIVE_WHITESPACES)
+    """How many consective whitespaces the JsonSchemaParser will allow"""
     force_json_field_order: bool = _env_or_default_field(CONFIG_ENV_VAR_LMFE_FORCE_JSON_FIELD_ORDER, 
                                                          DEFAULT_FORCE_JSON_FIELD_ORDER)
+    """Whether the JsonSchemaParser will force fields to appear in the 
+    order of the 'required' field in the schema"""
 
 
 class CharacterLevelParser(abc.ABC):