Update docstrings

Author: codeofdusk

src/gptcmd/cli.py

@@ -1,3 +1,13 @@
+"""
+This module contains the Gptcmd class and serves as an entry point to the
+Gptcmd command line application.
+Copyright 2024 Bill Dengler
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.
+"""
+
+
 import argparse
 import cmd
 import dataclasses
@@ -29,16 +39,6 @@
 )
 
 
-"""
-This module contains the Gptcmd class and serves as an entry point to the
-Gptcmd command line application.
-Copyright 2023 Bill Dengler
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at https://mozilla.org/MPL/2.0/.
-"""
-
-
 __version__ = "2.0.0"
 
 

src/gptcmd/config.py

@@ -1,3 +1,13 @@
+"""
+This module contains the ConfigManager class, which controls Gptcmd's
+config system.
+Copyright 2024 Bill Dengler
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.
+"""
+
+
 import dataclasses
 import os
 import sys
@@ -21,16 +31,6 @@
 from .llm.openai import AzureAI, OpenAI
 
 
-"""
-This module contains the ConfigManager class, which controls Gptcmd's
-config system.
-Copyright 2024 Bill Dengler
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at https://mozilla.org/MPL/2.0/.
-"""
-
-
 DEFAULT_PROVIDERS: Dict[str, Type[LLMProvider]] = {
     "openai": OpenAI,
     "azure": AzureAI,

src/gptcmd/llm/__init__.py

@@ -1,3 +1,12 @@
+"""
+This module contains the LLMProvider class and supporting infrastructure.
+Copyright 2024 Bill Dengler
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.
+"""
+
+
 import dataclasses
 from abc import ABC, abstractmethod
 from decimal import Decimal
@@ -16,15 +25,6 @@
 from ..message import Message, MessageAttachment, UnknownAttachment
 
 
-"""
-This module contains the LLMProvider class and supporting infrastructure.
-Copyright 2024 Bill Dengler
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at https://mozilla.org/MPL/2.0/.
-"""
-
-
 @dataclasses.dataclass
 class LLMResponse:
     message: Message

src/gptcmd/llm/openai.py

@@ -1,3 +1,12 @@
+"""
+This module contains implementations of LLMProvider for OpenAI and Azure.
+Copyright 2024 Bill Dengler
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.
+"""
+
+
 import inspect
 
 from decimal import Decimal
@@ -15,15 +24,6 @@
 import openai
 
 
-"""
-This module contains implementations of LLMProvider for OpenAI and Azure.
-Copyright 2024 Bill Dengler
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at https://mozilla.org/MPL/2.0/.
-"""
-
-
 class OpenAI(LLMProvider):
     SUPPORTED_FEATURES = (
         LLMProviderFeature.MESSAGE_NAME_FIELD

src/gptcmd/message.py

@@ -1,3 +1,13 @@
+"""
+This module contains classes and types for interacting with messages and
+message threads.
+Copyright 2024 Bill Dengler
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.
+"""
+
+
 import base64
 import dataclasses
 import mimetypes
@@ -25,16 +35,6 @@
     from strenum import StrEnum
 
 
-"""
-This module contains classes and types for interacting with messages and
-message threads.
-Copyright 2023 Bill Dengler
-This Source Code Form is subject to the terms of the Mozilla Public
-License, v. 2.0. If a copy of the MPL was not distributed with this
-file, You can obtain one at https://mozilla.org/MPL/2.0/.
-"""
-
-
 T = TypeVar("T")