skill-line-wrap

Enforce 80-column wrapping for Qt documentation and code samples.

19|29|Updated May 6, 2013
One-click install
npx skills add https://github.com/qt/qtqa --skill skill-line-wrap
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skill-line-wrap
Source: https://github.com/qt/qtqa/tree/main/documentation_review/skills/skill-line-wrap
Command: npx skills add https://github.com/qt/qtqa --skill skill-line-wrap

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Qt documentation and code samples frequently exceed recommended line lengths, reducing readability and increasing review overhead. This guide provides a clear rule-set for wrapping at 80 characters and managing exceptions, so teams can consistently format prose, code, and QDoc content.

Core Features & Use Cases

  • Enforce 80-column rule for code, QDoc commands, alt text, and prose (required vs advisory).
  • Provide structured guidance on indentation, break points, and continuation lines to maintain consistency.
  • Support applying guidelines during documentation reviews or automated pipelines for Qt projects.

Quick Start

Run the wrap-check on a Qt document to enforce 80-column limits and apply natural-break wrapping.

Frequently Asked Questions about skill-line-wrap

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce 80-column line wrapping for Qt documentation and code samples?

Enforce 80-column line wrapping for Qt documentation by running automated checks against C++ code blocks, QDoc commands, alt text, prose, and table content, ensuring consistent formatting and reducing review overhead across Qt projects. Prose is treated as advisory with an 110-character threshold.

What is the line length limit for QDoc commands and prose in Qt projects?

The line length limit for QDoc commands in Qt projects is a strict 80 characters, while prose is treated as advisory with a maximum threshold of 110 characters. This distinction maintains readability without aggressively breaking natural sentence flow.

How do I wrap C++ code blocks in QDoc files without breaking unbreakable elements?

Wrap C++ code blocks in QDoc files by applying natural-break wrapping at 80 characters and preserving unbreakable elements. The process provides structured guidance on indentation, break points, and continuation lines to maintain consistency without corrupting code syntax.

Can I integrate 80-column lint checks into automated Qt documentation pipelines?

Yes, you can integrate 80-column lint checks into automated Qt documentation pipelines. The workflow supports applying guidelines during documentation reviews or automated pipelines to enforce 80-character requirements and report clear, actionable feedback.

Does Qt documentation formatting require strict 80-character wrapping for all content types?

Qt documentation formatting does not require strict 80-character wrapping for all content types. While 80-character requirements are enforced for code and QDoc commands, prose is treated as advisory with an 110-character threshold to balance readability and formatting discipline.