Skip to content

Update logic to upgrade documentation quality#16

Merged
betogaona7 merged 6 commits intomainfrom
fix/ensure-quality
Aug 9, 2023
Merged

Update logic to upgrade documentation quality#16
betogaona7 merged 6 commits intomainfrom
fix/ensure-quality

Conversation

@betogaona7
Copy link
Copy Markdown
Contributor

@betogaona7 betogaona7 commented Aug 9, 2023

This PR splits documentation logic in two parts:

  • code components extractions
  • docstring generation

Both of them uses gpt-4 due to the limitations of gpt-3.5 to handle the extraction and generation.

The PR also fixes the logic behind generating READMEs by adding appropriate templates that suits the tasks better.

The PR also introduces updates in the README, hallucination checks, use of .env file, and minor changes in the overall logic.

Closes #1

@betogaona7 betogaona7 added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Aug 9, 2023
@betogaona7 betogaona7 self-assigned this Aug 9, 2023
@betogaona7 betogaona7 requested a review from giorgiop August 9, 2023 22:34
@betogaona7 betogaona7 merged commit c59d0a0 into main Aug 9, 2023
@betogaona7 betogaona7 deleted the fix/ensure-quality branch August 9, 2023 22:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Investigate issue of using output parser w GPT3 models versions

1 participant