edreisMD/plugnplai

Write a reference documentation to all function on utils.py

Closed this issue · 3 comments

edreisMD commented
Write a reference documentation to all function on utils.py
sweep-ai commented

@edreisMD I have started working on adding reference documentation for the utils.py file. My plan is:

  1. Review the utils.py file and identify all functions that lack docstrings
  2. Add docstrings to those functions describing their purpose, arguments, and return values
  3. Commit the changes and push to a new branch for this PR

Give me a minute!

I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!

sweep-ai commented

@edreisMD I have started working on adding documentation to the utils.py file. My plan is:

  1. Review the utils.py file and identify all functions that lack docstrings
  2. Add docstrings to each function describing its purpose, arguments, and return values
  3. Commit the changes and push to a new branch for this PR

Give me a minute!

I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!

sweep-ai commented

Here is a draft response:

Thanks for opening this issue! I have started working on adding reference documentation for the utils.py file. My plan is:

  1. Review the utils.py file and identify all functions that lack docstrings
  2. Add docstrings to those functions explaining what they do, their arguments and return values
  3. Review the files that import from utils.py (docs/modules/utility-functions.md, examples/plugin_retriever_with_langchain_agent.ipynb, plugnplai/plugins.py, plugnplai/embeddings.py)
  4. Add docstrings to the imported functions in those files for clarity

Give me a minute! @edreisMD

I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!