updated docs strings and added README.md
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
"module": "mail_intake.config",
|
||||
"content": {
|
||||
"path": "mail_intake.config",
|
||||
"docstring": "Global configuration models for Mail Intake.\n\n---\n\n## Summary\n\nThis module defines the **top-level configuration object** used to control\nmail ingestion behavior across adapters, authentication providers, and\ningestion workflows.\n\nConfiguration is intentionally explicit, immutable, and free of implicit\nenvironment reads to ensure predictability and testability.",
|
||||
"docstring": "# Summary\n\nGlobal configuration models for Mail Intake.\n\nThis module defines the **top-level configuration object** used to control\nmail ingestion behavior across adapters, authentication providers, and\ningestion workflows.\n\nConfiguration is intentionally explicit, immutable, and free of implicit\nenvironment reads to ensure predictability and testability.",
|
||||
"objects": {
|
||||
"dataclass": {
|
||||
"name": "dataclass",
|
||||
@@ -22,8 +22,8 @@
|
||||
"name": "MailIntakeConfig",
|
||||
"kind": "class",
|
||||
"path": "mail_intake.config.MailIntakeConfig",
|
||||
"signature": "<bound method Class.signature of Class('MailIntakeConfig', 20, 58)>",
|
||||
"docstring": "Global configuration for mail-intake.\n\nNotes:\n **Guarantees:**\n\n - This configuration is intentionally explicit and immutable\n - No implicit environment reads or global state\n - Explicit configuration over implicit defaults\n - No direct environment or filesystem access\n - This model is safe to pass across layers and suitable for serialization",
|
||||
"signature": "<bound method Class.signature of Class('MailIntakeConfig', 18, 57)>",
|
||||
"docstring": "Global configuration for `mail-intake`.\n\nNotes:\n **Guarantees:**\n\n - This configuration is intentionally explicit and immutable.\n - No implicit environment reads or global state.\n - Explicit configuration over implicit defaults.\n - No direct environment or filesystem access.\n - This model is safe to pass across layers and suitable for\n serialization.",
|
||||
"members": {
|
||||
"provider": {
|
||||
"name": "provider",
|
||||
|
||||
Reference in New Issue
Block a user