docstring-format-checker 1.11.2__tar.gz → 1.11.4__tar.gz

{docstring_format_checker-1.11.2 → docstring_format_checker-1.11.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docstring-format-checker
-Version: 1.11.2
+Version: 1.11.4
 Summary: A CLI tool to check and validate Python docstring formatting and completeness
 Author: Chris Mahoney
 Author-email: Chris Mahoney <docstring-format-checker@data-science-extensions.com>
@@ -72,7 +72,7 @@ Description-Content-Type: text/markdown
 </p>
 
 
-### Introduction
+### 📝 Introduction
 
 A powerful Python CLI tool that validates docstring formatting and completeness using AST parsing. Ensure consistent, high-quality documentation across your entire codebase with configurable validation rules and rich terminal output.
 
@@ -87,26 +87,26 @@ A powerful Python CLI tool that validates docstring formatting and completeness
 - 🛡️ **100% test coverage** - Thoroughly tested and reliable
 
 
-### Quick Start
+### 🚀 Quick Start
 
 ```bash
 # Install
 uv add docstring-format-checker
 
 # Check a single file
-dfc check my_module.py
+dfc --check my_module.py
 
 # Check entire directory
-dfc check src/
+dfc --check src/
 
 # Generate example configuration
-dfc config-example
+dfc --example=config
 ```
 
 
-### Key URLs
+### 🔗 Key URLs
 
-For reference, these URL's are used:
+For reference, these URLs are used:
 
 | Type           | Source | URL                                                                    |
 | -------------- | ------ | ---------------------------------------------------------------------- |
@@ -115,7 +115,7 @@ For reference, these URL's are used:
 | Package Docs   | Pages  | https://data-science-extensions.com/toolboxes/docstring-format-checker |
 
 
-### Section Types
+### 📂 Section Types
 
 Configure validation for four types of docstring sections:
 
@@ -127,7 +127,7 @@ Configure validation for four types of docstring sections:
 | `list_name_and_type` | Name and type lists       | Parameters, returns with types |
 
 
-### Configuration
+### ⚙️ Configuration
 
 Create a `pyproject.toml` with your validation rules. The `order` attribute is optional; sections without an order (like "deprecation warning") can appear anywhere in the docstring.
 
@@ -168,26 +168,27 @@ required = false
 Or like this in a single block:
 
 ```toml
-[tool.dfc]                                                                                                                                                                                             │
-# or [tool.docstring-format-checker]                                                                                                                                                                   │
-allow_undefined_sections = false                                                                                                                                                                       │
-require_docstrings = true                                                                                                                                                                              │
-check_private = true                                                                                                                                                                                   │
-validate_param_types = true                                                                                                                                                                            │
-optional_style = "validate"  # "silent", "validate", or "strict"                                                                                                                                       │
-sections = [                                                                                                                                                                                           │
-    { order = 1, name = "summary",  type = "free_text",          required = true, admonition = "note", prefix = "!!!" },                                                                               │
-    { order = 2, name = "details",  type = "free_text",          required = false, admonition = "abstract", prefix = "???+" },                                                                         │
-    { order = 3, name = "params",   type = "list_name_and_type", required = false },                                                                                                                   │
-    { order = 4, name = "raises",   type = "list_type",          required = false },                                                                                                                   │
-    { order = 5, name = "returns",  type = "list_name_and_type", required = false },                                                                                                                   │
-    { order = 6, name = "yields",   type = "list_type",          required = false },                                                                                                                   │
-    { order = 7, name = "examples", type = "free_text",          required = false, admonition = "example", prefix = "???+" },                                                                          │
-    { order = 8, name = "notes",    type = "free_text",          required = false, admonition = "note", prefix = "???" },                                                                              │
+[tool.dfc]
+# or [tool.docstring-format-checker]
+allow_undefined_sections = false
+require_docstrings = true
+check_private = true
+validate_param_types = true
+optional_style = "validate"  # "silent", "validate", or "strict"
+sections = [
+    { order = 1, name = "summary",  type = "free_text",          required = true, admonition = "note", prefix = "!!!" },
+    { order = 2, name = "details",  type = "free_text",          required = false, admonition = "abstract", prefix = "???+" },
+    { order = 3, name = "params",   type = "list_name_and_type", required = false },
+    { order = 4, name = "raises",   type = "list_type",          required = false },
+    { order = 5, name = "returns",  type = "list_name_and_type", required = false },
+    { order = 6, name = "yields",   type = "list_type",          required = false },
+    { order = 7, name = "examples", type = "free_text",          required = false, admonition = "example", prefix = "???+" },
+    { order = 8, name = "notes",    type = "free_text",          required = false, admonition = "note", prefix = "???" },
 ]
 ```
 
-### Installation
+
+### 📥 Installation
 
 You can install and use this package multiple ways by using any of your preferred methods: [`pip`][pip], [`pipenv`][pipenv], [`poetry`][poetry], or [`uv`][uv].
 
@@ -264,7 +265,7 @@ You can install and use this package multiple ways by using any of your preferre
     ```toml
     [project]
     dependencies = [
-        "docstring-format-checker==0.*",
+        "docstring-format-checker==1.*",
     ]
     ```
 
@@ -278,7 +279,7 @@ You can install and use this package multiple ways by using any of your preferre
 2. Or just run this:
 
     ```sh
-    poetry add "docstring-format-checker==0.*"
+    poetry add "docstring-format-checker==1.*"
     poetry sync
     poetry install
     ```
@@ -291,7 +292,7 @@ You can install and use this package multiple ways by using any of your preferre
     ```toml
     [project]
     dependencies = [
-        "docstring-format-checker==0.*",
+        "docstring-format-checker==1.*",
     ]
     ```
 
@@ -304,34 +305,34 @@ You can install and use this package multiple ways by using any of your preferre
 2. Or run this:
 
     ```sh
-    uv add "docstring-format-checker==0.*"
+    uv add "docstring-format-checker==1.*"
     uv sync
     ```
 
 3. Or just run this:
 
     ```sh
-    uv pip install "docstring-format-checker==0.*"
+    uv pip install "docstring-format-checker==1.*"
     ```
 
 
-### Usage Examples
-
-
-#### Basic Usage
+### 💡 Usage Examples
 
 ```bash
 # Check a single Python file
-dfc check src/my_module.py
+dfc --check src/my_module.py
+
+# Check multiple Python files
+dfc file1.py file2.py
 
 # Check entire directory recursively
-dfc check src/
+dfc --check src/
 
-# Check with verbose output
-dfc check --verbose src/
+# Check with table output format
+dfc --output=table src/
 
 # Generate example configuration file
-dfc config-example > pyproject.toml
+dfc --example=config > pyproject.toml
 ```
 
 
@@ -339,13 +340,16 @@ dfc config-example > pyproject.toml
 
 ```bash
 # Use custom config file location
-dfc check --config custom_config.toml src/
+dfc --config=custom_config.toml src/
+
+# Exclude specific files using glob patterns
+dfc src/ --exclude "**/test_*.py"
 
-# Check specific function patterns
-dfc check --include-pattern "**/api/*.py" src/
+# Stop on first failure (CI environments)
+dfc --check src/
 
-# Exclude test files
-dfc check --exclude-pattern "**/test_*.py" src/
+# Suppress non-error output
+dfc --quiet src/
 ```
 
 
@@ -363,43 +367,90 @@ jobs:
       - uses: actions/checkout@v4
       - uses: astral-sh/setup-uv@v3
       - run: uv pip install docstring-format-checker
-      - run: dfc check src/
+      - run: dfc --check src/
 ```
 
 
-### Example Output
+#### Integration with Pre-commit
 
+```yaml
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/data-science-extensions/docstring-format-checker
+    rev: "v1.11.3"
+    hooks:
+    -   id: docstring-format-checker
+        name: Docstring Format Checker
+        entry: dfc --check
 ```
-📋 Docstring Format Checker Results
 
-✅ src/utils/helpers.py
-❌ src/models/user.py
-   └── Function 'create_user' missing required section: 'params'
-   └── Function 'delete_user' missing required section: 'returns'
 
-❌ src/api/endpoints.py
-   └── Method 'UserAPI.get_user' invalid section format: 'raises'
+### 📋 Example Output
+
+
+#### Standard List Output
+
+The option `output=list` is the default:
+
+```sh
+dfc --check src/models/user.py
+```
+
+Or you can declare it explicitly:
+
+```sh
+dfc --check --output=list src/models/user.py
+```
+
+Which returns:
+
+```text
+src/models/user.py
+  Line 12 - function 'create_user':
+    - Missing required section: 'params'
+  Line 45 - function 'delete_user':
+    - Missing required section: 'returns'
+
+Found 2 error(s) in 2 functions over 1 file
+```
+
+
+#### Table Output Format
+
+```sh
+dfc --check --output=table src/models/user.py
+```
 
-📊 Summary: 1/3 files passed (33.3%)
+```text
+┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ File               ┃ Line ┃ Item        ┃ Type     ┃ Error                            ┃
+┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ src/models/user.py │   12 │ create_user │ function │ - Missing required section:      │
+│                    │      │             │          │ 'params'.                        │
+│                    │   45 │ delete_user │ function │ - Missing required section:      │
+│                    │      │             │          │ 'returns'.                       │
+└────────────────────┴──────┴─────────────┴──────────┴──────────────────────────────────┘
+
+Found 2 error(s) in 2 functions over 1 file
 ```
 
 
-### Architecture
+### 🏗️ Architecture
 
 The tool follows a clean, modular architecture:
 
-- **`core.py`** - `DocstringChecker` class with AST parsing and validation logic
-- **`config.py`** - Configuration loading and `SectionConfig` management
+- **`core.py`** - `DocstringChecker()` class with AST parsing and validation logic
+- **`config.py`** - Configuration loading and `SectionConfig()` management
 - **`cli.py`** - Typer-based CLI with dual entry points
 - **`utils/exceptions.py`** - Custom exception classes for structured error handling
 
 
-### Contribution
+### 🤝 Contribution
 
 Check the [CONTRIBUTING.md][github-contributing] file or [Contributing][docs-contributing] page.
 
 
-### Development
+### 🛠️ Development
 
 1. **Clone the repository:**
 
@@ -423,19 +474,19 @@ Check the [CONTRIBUTING.md][github-contributing] file or [Contributing][docs-con
 4. **Run CLI locally:**
 
     ```sh
-    uv run dfc check examples/example_code.py
+    uv run dfc --check examples/example_code.py
     ```
 
 
-### Build and Test
+### 🧪 Build and Test
 
-To ensure that the package is working as expected, please ensure that:
+To ensure that the package works as expected, ensure that:
 
-1. You write your code as per [PEP8][pep8] requirements.
-2. You write a [UnitTest][unittest] for each function/feature you include.
-3. The [CodeCoverage][codecov] is 100%.
-4. All [UnitTests][pytest] are passing.
-5. [MyPy][mypy] is passing 100%.
+1. Write code in accordance with [PEP8][pep8] requirements.
+2. Write a [UnitTest][unittest] for each function or feature included.
+3. Maintain [CodeCoverage][codecov] at 100%.
+4. Ensure all [UnitTests][pytest] pass.
+5. Ensure [MyPy][mypy] passes 100%.
 
 
 #### Testing
@@ -469,7 +520,7 @@ To ensure that the package is working as expected, please ensure that:
         ```
 
 
-### License
+### 📄 License
 
 This project is licensed under the MIT License - see the [LICENSE][github-license] file for details.
 

{docstring_format_checker-1.11.2 → docstring_format_checker-1.11.4}/README.md

@@ -35,7 +35,7 @@
 </p>
 
 
-### Introduction
+### 📝 Introduction
 
 A powerful Python CLI tool that validates docstring formatting and completeness using AST parsing. Ensure consistent, high-quality documentation across your entire codebase with configurable validation rules and rich terminal output.
 
@@ -50,26 +50,26 @@ A powerful Python CLI tool that validates docstring formatting and completeness
 - 🛡️ **100% test coverage** - Thoroughly tested and reliable
 
 
-### Quick Start
+### 🚀 Quick Start
 
 ```bash
 # Install
 uv add docstring-format-checker
 
 # Check a single file
-dfc check my_module.py
+dfc --check my_module.py
 
 # Check entire directory
-dfc check src/
+dfc --check src/
 
 # Generate example configuration
-dfc config-example
+dfc --example=config
 ```
 
 
-### Key URLs
+### 🔗 Key URLs
 
-For reference, these URL's are used:
+For reference, these URLs are used:
 
 | Type           | Source | URL                                                                    |
 | -------------- | ------ | ---------------------------------------------------------------------- |
@@ -78,7 +78,7 @@ For reference, these URL's are used:
 | Package Docs   | Pages  | https://data-science-extensions.com/toolboxes/docstring-format-checker |
 
 
-### Section Types
+### 📂 Section Types
 
 Configure validation for four types of docstring sections:
 
@@ -90,7 +90,7 @@ Configure validation for four types of docstring sections:
 | `list_name_and_type` | Name and type lists       | Parameters, returns with types |
 
 
-### Configuration
+### ⚙️ Configuration
 
 Create a `pyproject.toml` with your validation rules. The `order` attribute is optional; sections without an order (like "deprecation warning") can appear anywhere in the docstring.
 
@@ -131,26 +131,27 @@ required = false
 Or like this in a single block:
 
 ```toml
-[tool.dfc]                                                                                                                                                                                             │
-# or [tool.docstring-format-checker]                                                                                                                                                                   │
-allow_undefined_sections = false                                                                                                                                                                       │
-require_docstrings = true                                                                                                                                                                              │
-check_private = true                                                                                                                                                                                   │
-validate_param_types = true                                                                                                                                                                            │
-optional_style = "validate"  # "silent", "validate", or "strict"                                                                                                                                       │
-sections = [                                                                                                                                                                                           │
-    { order = 1, name = "summary",  type = "free_text",          required = true, admonition = "note", prefix = "!!!" },                                                                               │
-    { order = 2, name = "details",  type = "free_text",          required = false, admonition = "abstract", prefix = "???+" },                                                                         │
-    { order = 3, name = "params",   type = "list_name_and_type", required = false },                                                                                                                   │
-    { order = 4, name = "raises",   type = "list_type",          required = false },                                                                                                                   │
-    { order = 5, name = "returns",  type = "list_name_and_type", required = false },                                                                                                                   │
-    { order = 6, name = "yields",   type = "list_type",          required = false },                                                                                                                   │
-    { order = 7, name = "examples", type = "free_text",          required = false, admonition = "example", prefix = "???+" },                                                                          │
-    { order = 8, name = "notes",    type = "free_text",          required = false, admonition = "note", prefix = "???" },                                                                              │
+[tool.dfc]
+# or [tool.docstring-format-checker]
+allow_undefined_sections = false
+require_docstrings = true
+check_private = true
+validate_param_types = true
+optional_style = "validate"  # "silent", "validate", or "strict"
+sections = [
+    { order = 1, name = "summary",  type = "free_text",          required = true, admonition = "note", prefix = "!!!" },
+    { order = 2, name = "details",  type = "free_text",          required = false, admonition = "abstract", prefix = "???+" },
+    { order = 3, name = "params",   type = "list_name_and_type", required = false },
+    { order = 4, name = "raises",   type = "list_type",          required = false },
+    { order = 5, name = "returns",  type = "list_name_and_type", required = false },
+    { order = 6, name = "yields",   type = "list_type",          required = false },
+    { order = 7, name = "examples", type = "free_text",          required = false, admonition = "example", prefix = "???+" },
+    { order = 8, name = "notes",    type = "free_text",          required = false, admonition = "note", prefix = "???" },
 ]
 ```
 
-### Installation
+
+### 📥 Installation
 
 You can install and use this package multiple ways by using any of your preferred methods: [`pip`][pip], [`pipenv`][pipenv], [`poetry`][poetry], or [`uv`][uv].
 
@@ -227,7 +228,7 @@ You can install and use this package multiple ways by using any of your preferre
     ```toml
     [project]
     dependencies = [
-        "docstring-format-checker==0.*",
+        "docstring-format-checker==1.*",
     ]
     ```
 
@@ -241,7 +242,7 @@ You can install and use this package multiple ways by using any of your preferre
 2. Or just run this:
 
     ```sh
-    poetry add "docstring-format-checker==0.*"
+    poetry add "docstring-format-checker==1.*"
     poetry sync
     poetry install
     ```
@@ -254,7 +255,7 @@ You can install and use this package multiple ways by using any of your preferre
     ```toml
     [project]
     dependencies = [
-        "docstring-format-checker==0.*",
+        "docstring-format-checker==1.*",
     ]
     ```
 
@@ -267,34 +268,34 @@ You can install and use this package multiple ways by using any of your preferre
 2. Or run this:
 
     ```sh
-    uv add "docstring-format-checker==0.*"
+    uv add "docstring-format-checker==1.*"
     uv sync
     ```
 
 3. Or just run this:
 
     ```sh
-    uv pip install "docstring-format-checker==0.*"
+    uv pip install "docstring-format-checker==1.*"
     ```
 
 
-### Usage Examples
-
-
-#### Basic Usage
+### 💡 Usage Examples
 
 ```bash
 # Check a single Python file
-dfc check src/my_module.py
+dfc --check src/my_module.py
+
+# Check multiple Python files
+dfc file1.py file2.py
 
 # Check entire directory recursively
-dfc check src/
+dfc --check src/
 
-# Check with verbose output
-dfc check --verbose src/
+# Check with table output format
+dfc --output=table src/
 
 # Generate example configuration file
-dfc config-example > pyproject.toml
+dfc --example=config > pyproject.toml
 ```
 
 
@@ -302,13 +303,16 @@ dfc config-example > pyproject.toml
 
 ```bash
 # Use custom config file location
-dfc check --config custom_config.toml src/
+dfc --config=custom_config.toml src/
+
+# Exclude specific files using glob patterns
+dfc src/ --exclude "**/test_*.py"
 
-# Check specific function patterns
-dfc check --include-pattern "**/api/*.py" src/
+# Stop on first failure (CI environments)
+dfc --check src/
 
-# Exclude test files
-dfc check --exclude-pattern "**/test_*.py" src/
+# Suppress non-error output
+dfc --quiet src/
 ```
 
 
@@ -326,43 +330,90 @@ jobs:
       - uses: actions/checkout@v4
       - uses: astral-sh/setup-uv@v3
       - run: uv pip install docstring-format-checker
-      - run: dfc check src/
+      - run: dfc --check src/
 ```
 
 
-### Example Output
+#### Integration with Pre-commit
 
+```yaml
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/data-science-extensions/docstring-format-checker
+    rev: "v1.11.3"
+    hooks:
+    -   id: docstring-format-checker
+        name: Docstring Format Checker
+        entry: dfc --check
 ```
-📋 Docstring Format Checker Results
 
-✅ src/utils/helpers.py
-❌ src/models/user.py
-   └── Function 'create_user' missing required section: 'params'
-   └── Function 'delete_user' missing required section: 'returns'
 
-❌ src/api/endpoints.py
-   └── Method 'UserAPI.get_user' invalid section format: 'raises'
+### 📋 Example Output
+
+
+#### Standard List Output
+
+The option `output=list` is the default:
+
+```sh
+dfc --check src/models/user.py
+```
+
+Or you can declare it explicitly:
+
+```sh
+dfc --check --output=list src/models/user.py
+```
+
+Which returns:
+
+```text
+src/models/user.py
+  Line 12 - function 'create_user':
+    - Missing required section: 'params'
+  Line 45 - function 'delete_user':
+    - Missing required section: 'returns'
+
+Found 2 error(s) in 2 functions over 1 file
+```
+
+
+#### Table Output Format
+
+```sh
+dfc --check --output=table src/models/user.py
+```
 
-📊 Summary: 1/3 files passed (33.3%)
+```text
+┏━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ File               ┃ Line ┃ Item        ┃ Type     ┃ Error                            ┃
+┡━━━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ src/models/user.py │   12 │ create_user │ function │ - Missing required section:      │
+│                    │      │             │          │ 'params'.                        │
+│                    │   45 │ delete_user │ function │ - Missing required section:      │
+│                    │      │             │          │ 'returns'.                       │
+└────────────────────┴──────┴─────────────┴──────────┴──────────────────────────────────┘
+
+Found 2 error(s) in 2 functions over 1 file
 ```
 
 
-### Architecture
+### 🏗️ Architecture
 
 The tool follows a clean, modular architecture:
 
-- **`core.py`** - `DocstringChecker` class with AST parsing and validation logic
-- **`config.py`** - Configuration loading and `SectionConfig` management
+- **`core.py`** - `DocstringChecker()` class with AST parsing and validation logic
+- **`config.py`** - Configuration loading and `SectionConfig()` management
 - **`cli.py`** - Typer-based CLI with dual entry points
 - **`utils/exceptions.py`** - Custom exception classes for structured error handling
 
 
-### Contribution
+### 🤝 Contribution
 
 Check the [CONTRIBUTING.md][github-contributing] file or [Contributing][docs-contributing] page.
 
 
-### Development
+### 🛠️ Development
 
 1. **Clone the repository:**
 
@@ -386,19 +437,19 @@ Check the [CONTRIBUTING.md][github-contributing] file or [Contributing][docs-con
 4. **Run CLI locally:**
 
     ```sh
-    uv run dfc check examples/example_code.py
+    uv run dfc --check examples/example_code.py
     ```
 
 
-### Build and Test
+### 🧪 Build and Test
 
-To ensure that the package is working as expected, please ensure that:
+To ensure that the package works as expected, ensure that:
 
-1. You write your code as per [PEP8][pep8] requirements.
-2. You write a [UnitTest][unittest] for each function/feature you include.
-3. The [CodeCoverage][codecov] is 100%.
-4. All [UnitTests][pytest] are passing.
-5. [MyPy][mypy] is passing 100%.
+1. Write code in accordance with [PEP8][pep8] requirements.
+2. Write a [UnitTest][unittest] for each function or feature included.
+3. Maintain [CodeCoverage][codecov] at 100%.
+4. Ensure all [UnitTests][pytest] pass.
+5. Ensure [MyPy][mypy] passes 100%.
 
 
 #### Testing
@@ -432,7 +483,7 @@ To ensure that the package is working as expected, please ensure that:
         ```
 
 
-### License
+### 📄 License
 
 This project is licensed under the MIT License - see the [LICENSE][github-license] file for details.
 

{docstring_format_checker-1.11.2 → docstring_format_checker-1.11.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "docstring-format-checker"
-version = "1.11.2"
+version = "1.11.4"
 description = "A CLI tool to check and validate Python docstring formatting and completeness"
 readme = "README.md"
 license = "MIT"

{docstring_format_checker-1.11.2 → docstring_format_checker-1.11.4}/src/docstring_format_checker/cli.py

@@ -199,14 +199,6 @@ def _show_usage_examples_callback() -> None:
     !!! note "Summary"
         Show examples and exit.
 
-    Params:
-        ctx (Context):
-            The context object.
-        param (CallbackParam):
-            The parameter object.
-        value (bool):
-            The boolean value indicating if the flag was set.
-
     Returns:
         (None):
             Nothing is returned.
@@ -248,14 +240,6 @@ def _show_config_example_callback() -> None:
     !!! note "Summary"
         Show configuration example and exit.
 
-    Params:
-        ctx (Context):
-            The context object.
-        param (CallbackParam):
-            The parameter object.
-        value (bool):
-            The boolean value indicating if the flag was set.
-
     Returns:
         (None):
             Nothing is returned.

{docstring_format_checker-1.11.2 → docstring_format_checker-1.11.4}/src/docstring_format_checker/config.py

@@ -44,7 +44,7 @@
 
 # ## Python StdLib Imports ----
 import sys
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from pathlib import Path
 from typing import Any, Literal, Optional, Union
 
@@ -111,11 +111,41 @@ class GlobalConfig:
         Global configuration for docstring checking behavior.
     """
 
-    allow_undefined_sections: bool = False
-    require_docstrings: bool = True
-    check_private: bool = False
-    validate_param_types: bool = True
-    optional_style: Literal["silent", "validate", "strict"] = "validate"
+    allow_undefined_sections: bool = field(
+        default=False,
+        metadata={
+            "title": "Allow Undefined Sections",
+            "description": "Allow sections not defined in the configuration.",
+        },
+    )
+    require_docstrings: bool = field(
+        default=True,
+        metadata={
+            "title": "Require Docstrings",
+            "description": "Require docstrings for all functions/methods.",
+        },
+    )
+    check_private: bool = field(
+        default=False,
+        metadata={
+            "title": "Check Private Members",
+            "description": "Check docstrings for private members (starting with an underscore).",
+        },
+    )
+    validate_param_types: bool = field(
+        default=True,
+        metadata={
+            "title": "Validate Parameter Types",
+            "description": "Validate that parameter types are provided in the docstring.",
+        },
+    )
+    optional_style: Literal["silent", "validate", "strict"] = field(
+        default="validate",
+        metadata={
+            "title": "Optional Style",
+            "description": "The style for reporting issues in optional sections.",
+        },
+    )
 
 
 ## --------------------------------------------------------------------------- #
@@ -130,13 +160,53 @@ class SectionConfig:
         Configuration for a docstring section.
     """
 
-    name: str
-    type: Literal["free_text", "list_name", "list_type", "list_name_and_type"]
-    order: Optional[int] = None
-    admonition: Union[bool, str] = False
-    prefix: str = ""  # Support any prefix string
-    required: bool = False
-    message: str = ""  # Optional message for validation errors
+    name: str = field(
+        metadata={
+            "title": "Name",
+            "description": "Name of the docstring section.",
+        },
+    )
+    type: Literal["free_text", "list_name", "list_type", "list_name_and_type"] = field(
+        metadata={
+            "title": "Type",
+            "description": "Type of the section content.",
+        },
+    )
+    order: Optional[int] = field(
+        default=None,
+        metadata={
+            "title": "Order",
+            "description": "Order of the section in the docstring.",
+        },
+    )
+    admonition: Union[bool, str] = field(
+        default=False,
+        metadata={
+            "title": "Admonition",
+            "description": "Admonition style for the section. Can be False (no admonition) or a string specifying the admonition type.",
+        },
+    )
+    prefix: str = field(
+        default="",
+        metadata={
+            "title": "Prefix",
+            "description": "Prefix string for the admonition values.",
+        },
+    )
+    required: bool = field(
+        default=False,
+        metadata={
+            "title": "Required",
+            "description": "Whether this section is required in the docstring.",
+        },
+    )
+    message: str = field(
+        default="",
+        metadata={
+            "title": "Message",
+            "description": "Optional message for validation errors.",
+        },
+    )
 
     def __post_init__(self) -> None:
         """