Skip to content

Warn when project description exceeds 80 characters#2873

Open
wahajahmed010 wants to merge 1 commit into
beeware:mainfrom
wahajahmed010:fix/2864-long-description-warning
Open

Warn when project description exceeds 80 characters#2873
wahajahmed010 wants to merge 1 commit into
beeware:mainfrom
wahajahmed010:fix/2864-long-description-warning

Conversation

@wahajahmed010
Copy link
Copy Markdown

When an app's description exceeds 80 characters, MSI installers can experience icon corruption because the Windows shortcut description field is limited to 256 bytes — the overflow truncates the prefix of the icon path. This warning directs users to the long_description field for longer text, which is the intended use.

Changes:

  • Added a console warning when description > 80 characters in parse_config()
  • Warning includes the app name, character count, and a suggestion to use long_description
  • The warning fires once per app during configuration parsing

Assisted-by: Claude Opus 4.5 (AI coding assistant - automated)

PR Checklist:

Adds a warning in parse_config() when an app description is longer
than 80 characters, directing users to use the long_description field
for longer text instead. Long descriptions can cause icon corruption
in MSI installers (the description field in Windows shortcuts is
limited to 256 characters, and overflow truncates the icon path).

Refs beeware#2864.

Signed-off-by: Wahaj Ahmed <wahaj.ahmed010@gmail.com>
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.

Long project descriptions cause icons to be blank on MSI installers

1 participant