Increase max description length to 1024 characters

[SAKURA-CAT]

Description

Updated the check_desc_format function to allow descriptions up to 1024 characters instead of 255, accommodating longer input as needed.

[gemini-code-assist]

Summary of Changes

Hello @SAKURA-CAT, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses the need for more extensive descriptive text by updating the check_desc_format function. The change allows users to provide significantly longer descriptions, enhancing the ability to convey detailed context without truncation and improving overall expressiveness within the system.

Highlights

• Description Length Increase: The maximum allowed length for descriptions has been increased from 255 characters to 1024 characters, accommodating more detailed input.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request correctly increases the maximum description length to 1024 characters. While the change is simple, I have a few points to improve the overall quality and robustness of the code.

First, I've suggested replacing the hardcoded 'magic number' 1024 with a constant to improve code clarity and maintainability.

Second, and more importantly, the check_desc_format function lacks unit tests. Adding tests to test/unit/test_formatter.py is crucial to verify the new length limit and the auto-truncation logic, which will help prevent future regressions. You could add a new test class similar to TestExpName to cover various scenarios.

Finally, while reviewing the file, I noticed a potential bug in the check_job_type_format function: its docstring claims a max length of 256, but the code enforces 255. It would be great if you could take a look at that as well.