Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v0.2.4 #60

Merged
merged 12 commits into from
Dec 5, 2024
Merged

Release v0.2.4 #60

merged 12 commits into from
Dec 5, 2024

Conversation

jcrodriguez1989
Copy link
Owner

No description provided.

Copy link

github-actions bot commented Aug 7, 2024

I have reviewed the GitHub PR diff provided:

Issues Found:

  1. In R/ask_chatgpt.R file, the parameter session_id and openai_api_key were removed from the ask_chatgpt function without updating the function documentation accordingly.

    • File: R/ask_chatgpt.R
    • Lines: 8-10
  2. In R/ask_chatgpt.R file, the function reset_chat_session is called without the session_id parameter, which was removed from the function signature.

    • File: R/ask_chatgpt.R
    • Line: 19
  3. In R/reset_chat_session.R file, the system_role parameter in the reset_chat_session function is not actually used within the function.

    • File: R/reset_chat_session.R
    • Line: 10

Note:

  • These issues are more related to code maintenance and documentation consistency rather than functional errors. It would be good to update the documentation and function calls to maintain consistency and clarity.

Let me know if you need any further assistance.

Copy link

github-actions bot commented Aug 8, 2024

I have reviewed the GitHub PR diff and found the following issues:

In the file R/ask_chatgpt.R, on line 6, the parameter session_id and openai_api_key have been removed from the ask_chatgpt function definition without updating the associated documentation. It seems like these parameters are no longer used in the function, so the documentation should be updated accordingly or removed.

In the file R/chatgpt-package.R, on line 6, the assignment of chat_session_messages on startup seems to be changed to include a specific message. This change might unexpectedly overwrite any initial values set for chat_session_messages.

Those are the issues I identified during the code review.

Copy link

I have reviewed the GitHub PR diff provided. Here are the issues I found:

  1. Inconsistency in Function Parameters: In the ask_chatgpt.R file, the function ask_chatgpt has been updated to include new parameters such as session_id, openai_api_key, and images. However, this change is not reflected in the corresponding Roxygen documentation in the README.Rmd file and the generated .Rd files.

    • Location: R/ask_chatgpt.R, README.Rmd, man/ask_chatgpt.Rd
  2. Misspelling in Environment Variable: In the README.Rmd file, there is a typo in the default setting for the OPENAI_MODEL environment variable where it should be "gpt-4o-mini" instead of "gpt-4o-mini".

    • Location: README.Rmd
  3. Missing Environment Variable: The OPENAI_LOGPROBS environment variable has been added, but it's missing from the list of environment variables and their descriptions in the README.Rmd file.

    • Location: README.Rmd

Please make the necessary adjustments to address these issues.4. Missing Documentation for New Functions: The newly added functions build_prompt_content, generate_image, get_chat_session, list_models, and reset_chat_session in the R directory do not have corresponding Roxygen documentation in the .Rd files.
- Locations: R/build_prompt_content.R, R/generate_image.R, R/get_chat_session.R, R/list_models.R, R/reset_chat_session.R

  1. Function Argument Description in Roxygen: The Roxygen documentation in the build_prompt_content.R file is missing the argument descriptions for question and images.

    • Location: R/build_prompt_content.R
  2. Incomplete Function Description in Roxygen: The Roxygen documentation in the reset_chat_session.R file has an incomplete description. It should provide more context on how the function works and its purpose.

    • Location: R/reset_chat_session.R

Please update the Roxygen documentation for the new functions and address any missing or incomplete information in the existing documentation. Let me know if you need further assistance.

@jcrodriguez1989 jcrodriguez1989 merged commit 16b43dd into main Dec 5, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant