← Back to issue list

docs: truncated sentence

View original Github issue

Metadata

Project
snapcraft
Number
#6331
Type
issue
State
open
Author
CAD97
Labels
—
Created
Updated
Closed
—

Current evaluation

Docs bug: snapcraft's docs/explanation/parts.rst includes craft-parts common docs with :start-line: 5, which skips the first line of the opening paragraph, rendering 'About parts' with a mid-sentence start. Root cause identified.

Suggested action: needs triage

Reason: Valid, precisely scoped docs defect: the reporter supplied screenshots and the exact expected text, and the root cause is verifiable in-tree — snapcraft's docs/explanation/parts.rst uses '.. include:: /common/craft-parts/explanation/parts.rst' with ':start-line: 5', which cuts the opening paragraph's first line, while craft-parts' source still holds the complete sentence. The only comment (Jha-2022) correctly identified that content is pulled from craft-parts but concluded the fix was therefore out of reach, when the start-line offset is a snapcraft-local value. There are no labels, no assignee, and no maintainer response, so the issue has not yet been triaged despite being a near-turnkey one-line fix.

Evaluated by: mr-cal-bot

Impact: 25 Quick Win: 17 Complexity: 15 Confidence: 88 Actionability: 80

Issue body

*"About parts - Snapcraft 9.0 documentation".* <img width="1564" height="228" alt="Screenshot of the top of the About Parts documentation. The first paragraph starts with a non-capitalized word in the middle of a sentence." src="https://github.com/user-attachments/assets/e3d62058-334d-4599-bb5d-182d2d718534" /> I think you a word 8.17 had a full sentence: <img width="1568" height="358" alt="Screenshot of the top of the About Parts documentation. The first paragraph contains full sentences, with the paragraph from the prior screenshot being a suffix of this paragraph." src="https://github.com/user-attachments/assets/fe4153ba-59f9-40b1-8c80-02b0d623837e" /> "payload, either individually or as part of a larger project containing many components." should be "A part is a description of the components to be built and prepared for deployment in a payload, either individually or as part of a larger project containing many components.". --- *Reported from: https://documentation.ubuntu.com/snapcraft/9.0/explanation/parts/*

Evaluation history

Date Model Scores Action Summary
stealth/space-bunny-alpha
Impact: 25
Quick Win: 17
Complexity: 15
Confidence: 88
Actionability: 80
needs triage Docs bug: snapcraft's docs/explanation/parts.rst includes craft-parts common docs with :start-line: 5, which skips the first line of the opening paragraph, rendering 'About parts' with a mid-sentence start. Root cause identified.
stealth/space-bunny-alpha
Impact: 12
Quick Win: 7
Complexity: 18
Confidence: 88
Actionability: 72
needs triage Reported truncation at the start of About parts; the text comes from craft-parts, and the cross-repository documentation fix remains untriaged.
stealth/space-bunny-alpha
Impact: 20
Quick Win: 17
Complexity: 10
Confidence: 98
Actionability: 95
needs triage About Parts omits the start of its first sentence because a shared include begins on the second line; a one-line documentation fix awaits maintainer triage.
qwen3.6-35b-a3b-mtp-q6
Impact: 20
Quick Win: 18
Staleness: 55
Complexity: 10
Confidence: 80
Support Request: 0
needs triage Truncated sentence in About Parts documentation due to incorrect include start-line in docs/explanation/parts.rst
qwen/qwen3.6-35b-a3b
Staleness: 5
Complexity: 10
Confidence: 90
Support Request: 10
needs triage Snapcraft 9.0 docs contain a truncated sentence in the About Parts section. A contributor suggested a fix but noted the content is pulled from the external craft-parts repo. Awaiting maintainer triage.
qwen3.6-35b-a3b-mtp-q6
Staleness: 0
Complexity: 0
Confidence: 95
Support Request: 0
needs triage External contributor reports a truncated sentence in Snapcraft 9.0 documentation, providing the full original text from version 8.17 as a fix. Issue is new and unlabelled.

Update history

No update history recorded yet.

Related issues

No related issues found above the similarity threshold.