170 add format to description generation for pr

[sauravpanda]

Summary

Adds formatting to the description generation process for the pull request.

Details

• Refactored the code to format the description generation for the pull request.
• Enhanced readability and maintainability by reformatting the UI module identification and Playwright code generation sections.
• Applied consistent formatting to the provider.py file for improved code structure and consistency.

✨ Generated with love by Kaizen ❤️

Original Description

None

[kaizen-bot]

Code Review

✅ All Clear: This PR is ready to merge! 👍

Improvements

[important] -> Consider adding docstrings to functions to describe their purpose, parameters, and return values.

Potential Solution:

Add informative docstrings to describe the purpose, parameters, and return values of functions.

kaizen/generator/ui.py | 68 - 68

✨ Generated with love by Kaizen ❤️

[cloudcodeai-nightly]

Code Review

✅ All Clear: This PR is ready to merge! 👍

Code Quality

[important] -> The prompt strings for the description generator are complex. Consider using a multiline string (=`strip()` or `dedent()` from the `textwrap` module to improve readability and manage indentation more effectively.

Potential Solution:

Refactor the PR description prompt to use dedent() from the textwrap module. This way, you can keep the inner indentation consistent with Python's styling guidelines while still having cleanly formatted text outputs.

kaizen/llms/prompts.py | 107 - 142

[important] -> Lines inside the `prompt` assignment are too long, consider limiting line length to 79 characters for better readability and adherence to PEP 8 standards.

Potential Solution:

Break down long lines in the prompt assignments to keep line length within 79 characters.

kaizen/llms/prompts.py | 118 - 118

✨ Generated with love by Kaizen ❤️