Add comprehensive documentation for all public-facing functions

[sweep-ai]

Description

This PR addresses Issue #4 by adding comprehensive documentation for all public-facing functions in the codebase. The lack of sufficient documentation in the initial codebase makes it difficult for users to understand and use the library effectively. By adding detailed documentation in the DoCC format, this PR aims to improve the usability and maintainability of the library.

Summary of Changes

• Added DoCC format documentation for the public-facing functions in the following files:
  • Sources/ChatGPT/Messaging/Conversation/Conversation_submit.swift
  • Sources/ChatGPT/Messaging/Responses/Usage.swift
  • Sources/ChatGPT/Messaging/Responses/Response.swift
  • Sources/ChatGPT/Messaging/Message.swift
• Reviewed and revised existing documentation where applicable to ensure completeness and accuracy.
• Ensured that the documentation includes details about the function's purpose, parameters, return types, and any side effects or exceptions.

Please review the changes and provide any feedback or suggestions. Thank you!

Fixes #4.

To checkout this PR branch, run the following command in your terminal:

git checkout sweep/add-documentation

[sweep-ai]

GitHub actions yielded the following error.

The relevant lines from the logs are:

##[group]Setup CodeQL tools
Did not find CodeQL tools version 2.14.1 in the toolcache.
[command]/usr/bin/tar xz -C /Users/runner/work/_temp/749cd31b-3461-4bb8-9ea0-ca26527f3cff -f /Users/runner/work/_temp/886fe7ae-2b99-461f-bc5c-24197b859d4f
2.14.1
{
"productName" : "CodeQL",
"vendor" : "GitHub",
"version" : "2.14.1",
"sha" : "4580f557b4909154ce2a6bef0cb4ca342be5a417",
"branches" : [
"codeql-cli-2.14.1"
],
"copyright" : "Copyright (C) 2019-2023 GitHub, Inc.",
"unpackedLocation" : "/Users/runner/hostedtoolcache/CodeQL/2.14.1-v2.14.1/x64/codeql",
"configFileLocation" : "/Users/runner/.config/codeql/config",
"configFileFound" : false
}
##[endgroup]

The command that failed is /usr/bin/tar xz -C /Users/runner/work/_temp/749cd31b-3461-4bb8-9ea0-ca26527f3cff -f /Users/runner/work/_temp/886fe7ae-2b99-461f-bc5c-24197b859d4f.

There are a lot of errors. This is likely a larger issue with the PR and not a small linting/type-checking issue.

This is likely a linting or type-checking issue with the source code but if you are updating the GitHub Actions or versioning, this could be an issue with the GitHub Action yaml files.

[sweep-ai]

GitHub actions yielded the following error.

The relevant lines from the logs are:

##[group]Setup CodeQL tools
Did not find CodeQL tools version 2.14.1 in the toolcache.
[command]/usr/bin/tar xz -C /Users/runner/work/_temp/de19703c-6113-4a9c-b20f-a022249b2d07 -f /Users/runner/work/_temp/124b683c-15df-465d-86c5-6dd872e2b6eb
2.14.1
{
"productName" : "CodeQL",
"vendor" : "GitHub",
"version" : "2.14.1",
"sha" : "4580f557b4909154ce2a6bef0cb4ca342be5a417",
"branches" : [
"codeql-cli-2.14.1"
],
"copyright" : "Copyright (C) 2019-2023 GitHub, Inc.",
"unpackedLocation" : "/Users/runner/hostedtoolcache/CodeQL/2.14.1-v2.14.1/x64/codeql",
"configFileLocation" : "/Users/runner/.config/codeql/config",
"configFileFound" : false
}
##[endgroup]

The command that failed is /usr/bin/tar xz -C /Users/runner/work/_temp/de19703c-6113-4a9c-b20f-a022249b2d07 -f /Users/runner/work/_temp/124b683c-15df-465d-86c5-6dd872e2b6eb.

There are a lot of errors. This is likely a larger issue with the PR and not a small linting/type-checking issue.

This is likely a linting or type-checking issue with the source code but if you are updating the GitHub Actions or versioning, this could be an issue with the GitHub Action yaml files.

[sweep-ai]

GitHub actions yielded the following error.

The relevant lines from the logs are:

##[group]Setup CodeQL tools
Did not find CodeQL tools version 2.14.1 in the toolcache.
[command]/usr/bin/tar xz -C /Users/runner/work/_temp/c0c24bb0-73a5-452c-811e-141f62461e16 -f /Users/runner/work/_temp/47bab5ce-958f-40f5-97a3-8180fc947f18
2.14.1
{
"productName" : "CodeQL",
"vendor" : "GitHub",
"version" : "2.14.1",
"sha" : "4580f557b4909154ce2a6bef0cb4ca342be5a417",
"branches" : [
"codeql-cli-2.14.1"
],
"copyright" : "Copyright (C) 2019-2023 GitHub, Inc.",
"unpackedLocation" : "/Users/runner/hostedtoolcache/CodeQL/2.14.1-v2.14.1/x64/codeql",
"configFileLocation" : "/Users/runner/.config/codeql/config",
"configFileFound" : false
}
##[endgroup]

The command that failed is /usr/bin/tar xz -C /Users/runner/work/_temp/c0c24bb0-73a5-452c-811e-141f62461e16 -f /Users/runner/work/_temp/47bab5ce-958f-40f5-97a3-8180fc947f18.

There are a lot of errors. This is likely a larger issue with the PR and not a small linting/type-checking issue.

This is likely a linting or type-checking issue with the source code but if you are updating the GitHub Actions or versioning, this could be an issue with the GitHub Action yaml files.

[sweep-ai]

GitHub actions yielded the following error.

The relevant lines from the logs are:

##[group]Setup CodeQL tools
Did not find CodeQL tools version 2.14.1 in the toolcache.
[command]/usr/bin/tar xz -C /Users/runner/work/_temp/9977f7b6-08a3-4cb8-97f8-c37e148886c7 -f /Users/runner/work/_temp/21b244cb-bf5d-4f4c-8a2d-b930c62e6a40
2.14.1
{
"productName" : "CodeQL",
"vendor" : "GitHub",
"version" : "2.14.1",
"sha" : "4580f557b4909154ce2a6bef0cb4ca342be5a417",
"branches" : [
"codeql-cli-2.14.1"
],
"copyright" : "Copyright (C) 2019-2023 GitHub, Inc.",
"unpackedLocation" : "/Users/runner/hostedtoolcache/CodeQL/2.14.1-v2.14.1/x64/codeql",
"configFileLocation" : "/Users/runner/.config/codeql/config",
"configFileFound" : false
}
##[endgroup]

The command that failed is /usr/bin/tar xz -C /Users/runner/work/_temp/9977f7b6-08a3-4cb8-97f8-c37e148886c7 -f /Users/runner/work/_temp/21b244cb-bf5d-4f4c-8a2d-b930c62e6a40.

There are a lot of errors. This is likely a larger issue with the PR and not a small linting/type-checking issue.

This is likely a linting or type-checking issue with the source code but if you are updating the GitHub Actions or versioning, this could be an issue with the GitHub Action yaml files.

[sweep-ai]

GitHub actions yielded the following error.

The relevant lines from the logs are:

##[group]Run github/codeql-action/init@v2
with:
languages: swift
token: ***
matrix: {
"language": "swift"
}
setup-python-dependencies: true
debug: false
##[endgroup]

The command that failed is github/codeql-action/init@v2.

There are a lot of errors. This is likely a larger issue with the PR and not a small linting/type-checking issue.

This is likely a linting or type-checking issue with the source code but if you are updating the GitHub Actions or versioning, this could be an issue with the GitHub Action yaml files.

[sweep-ai]

GitHub actions yielded the following error.

The relevant lines from the logs are:

##[group]Run github/codeql-action/init@v2
with:
languages: swift
token: ***
matrix: {
"language": "swift"
}
setup-python-dependencies: true
debug: false
##[endgroup]

The command that failed is github/codeql-action/init@v2.

There are a lot of errors. This is likely a larger issue with the PR and not a small linting/type-checking issue.

This is likely a linting or type-checking issue with the source code but if you are updating the GitHub Actions or versioning, this could be an issue with the GitHub Action yaml files.

[sweep-ai]

GitHub actions yielded the following error.

The relevant lines from the logs are:

##[group]Run github/codeql-action/init@v2
with:
languages: swift
token: ***
matrix: {
"language": "swift"
}
setup-python-dependencies: true
debug: false
##[endgroup]

The command that failed is github/codeql-action/init@v2.

There are a lot of errors. This is likely a larger issue with the PR and not a small linting/type-checking issue.

This is likely a linting or type-checking issue with the source code but if you are updating the GitHub Actions or versioning, this could be an issue with the GitHub Action yaml files.

I'm getting the same errors 3 times in a row, so I will stop working on fixing this PR.