Skip to content

Commit

Permalink
chore: module docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
phil65 committed Dec 10, 2024
1 parent d6e6a01 commit e7546a4
Show file tree
Hide file tree
Showing 17 changed files with 32 additions and 3 deletions.
2 changes: 2 additions & 0 deletions src/llmling/config/store.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Manages stored config mappings."""

from __future__ import annotations

from dataclasses import dataclass
Expand Down
1 change: 1 addition & 0 deletions src/llmling/core/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Module for LLMling core classes."""
3 changes: 2 additions & 1 deletion src/llmling/core/baseregistry.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# llmling/core/registry.py
"""Base class for component registries."""

from __future__ import annotations

from abc import ABC, abstractmethod
Expand Down
1 change: 1 addition & 0 deletions src/llmling/monitors/implementations/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
"""Monitor implementations."""
2 changes: 2 additions & 0 deletions src/llmling/monitors/utils.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Utility functions for the watcher."""

from __future__ import annotations

from typing import TYPE_CHECKING
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/processors/base.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Base classes for content processors."""

from __future__ import annotations

from abc import ABC, abstractmethod
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/processors/jinjaprocessor.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Builtin Jinja2 processor.."""

from __future__ import annotations

from typing import TYPE_CHECKING
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/processors/registry.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Registry for content processors."""

from __future__ import annotations

import asyncio
Expand Down
4 changes: 4 additions & 0 deletions src/llmling/prompts/__init__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
"""Prompt classes and registry for defining and managing prompts."""

from __future__ import annotations

from llmling.prompts.models import (
BasePrompt,
DynamicPrompt,
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/resources/loaders/callable.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Callable resource loader implementation."""

from __future__ import annotations

from typing import TYPE_CHECKING, ClassVar
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/resources/loaders/path.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Resource loader for files and URLs."""

from __future__ import annotations

from typing import TYPE_CHECKING, Any, ClassVar
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/resources/loaders/repository.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Resource loader for Git repositories."""

from __future__ import annotations

import tempfile
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/resources/loaders/source.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Loader for Python source code."""

from __future__ import annotations

import sys
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/resources/loaders/text.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Resource loader for text content."""

from __future__ import annotations

from typing import TYPE_CHECKING, ClassVar
Expand Down
2 changes: 2 additions & 0 deletions src/llmling/tools/base.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
"""Base class for implementing tools callable by an LLM via tool calling."""

from __future__ import annotations

from abc import ABC, abstractmethod
Expand Down
2 changes: 1 addition & 1 deletion src/llmling/utils/calling.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Callable context loader."""
"""Callable execution utilities."""

from __future__ import annotations

Expand Down
2 changes: 1 addition & 1 deletion src/llmling/utils/importing.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Source code context loader."""
"""Utilities for importing callables and classes from dotted paths."""

from __future__ import annotations

Expand Down

0 comments on commit e7546a4

Please sign in to comment.