Add docstrings

[mjspeck]

Obviously this would be pretty big for a single issue but that fact that most methods don't seem to have docstrings is troubling. The tutorials you have are very helpful but they're not a full replacement for actual docstrings, type annotations, etc. which make it much easier to build using llmware. Happy to contribute as well, but that would require knowing what docstring format y'all prefer and other style guide standards.

[rahpandey1]

I can also contribute

[doberst]

@mjspeck and @rahpandey1 - appreciate this feedback. We have taken initial steps on docstrings - very simple and lightweight through the main code. Realize that there is a lot more to do here - would welcome ideas and help to improve on this starting point. On type annotations for Python, we have debated it internally quite a bit - and right now, would probably side with prioritizing docstrings as well as core documentation.

[MacOS]

I'm also happy to contribute on this!

[MacOS]

I would suggest to add docstrings systematically in the following order, where one point is one issues and hence one pull request.

1. Add docstrings to all modules,
2. Add docstrings to all classes and functions,
3. Add docstrings to all methods and class methods.

[MacOS]

I submitted the pull request #406 that adds docstrings to all modules, and the package.

After this PR has been merged, we can move forward by adding docstrings to the classes.

[MacOS]

I submitted the pull request #449 to add class docstrings to four modules. I decided to split up adding class docstrings, since one pull request that adds class docstrings to all classes would be too large.

[MacOS]

To better organise the documentation effort, here is a list of what needs to be done, including what has already been done and what still needs to be done.

• Package docstring (PR Add docstrings for all modules and the package #406)
• Module docstrings (PR Add docstrings for all modules and the package #406)
  • agents (PR Add docstrings for all modules and the package #406)
  • configs (PR Add docstrings for all modules and the package #406)
  • embeddings (PR Add docstrings for all modules and the package #406)
  • exceptions (PR Add docstrings for all modules and the package #406)
  • library (PR Add docstrings for all modules and the package #406)
  • model_configs (PR Add docstrings for all modules and the package #406)
  • models (PR Add docstrings for all modules and the package #406)
  • parsers (PR Add docstrings for all modules and the package #406)
  • prompts (PR Add docstrings for all modules and the package #406)
  • resources (PR Add docstrings for all modules and the package #406)
  • retrieval (PR Add docstrings for all modules and the package #406)
  • setup (PR Add docstrings for all modules and the package #406)
  • status (PR Add docstrings for all modules and the package #406)
  • util (PR Add docstrings for all modules and the package #406)
• Class docstrings (PR Add class docstrings to classes in the modules agents, embeddings, library, and status #449, )
  • module agents (PR Add class docstrings to classes in the modules agents, embeddings, library, and status #449)
  • module embeddings (PR Add class docstrings to classes in the modules agents, embeddings, library, and status #449)
  • module library (PR Add class docstrings to classes in the modules agents, embeddings, library, and status #449)
  • module status (PR Add class docstrings to classes in the modules agents, embeddings, library, and status #449)
  • module configs
  • module exceptions
  • module model_configs
  • module models
  • module parsers
  • module prompts (PR Add class docstrings to module prompts #495)
  • module resources
  • module retrieval (PR Add class docstrings to the classes in module retrieval #478)
  • module setup (PR Add class docstrings to the classes in module setup #473)
  • module util
• Method docstrings
  • module library
    • class Library
    • class LibraryCatalog

[mjspeck]

Sorry I haven't been active on this. I'll take a look in the next week at what I can contribute.

[MacOS]

@mjspeck No worries. Please post first on what you are working before you start. I would recommend that you pick on module and add class docstrings to all classes there, and then submit this as a PR. Otherwise, the PR gets too big.

[doberst]

Docstrings substantially complete throughout the code base. If specific request, we can open up as a new issue.