Every comment reworded in plain technical prose has been fixed.
See more details at : https://github.com/pdulvp/pmane-sa/issues/2
- the comments across src/, tools/, CMakeLists.txt, cmake/, debian/,
data/ and .vscode/ rewritten: no personified widgets, no em-dash asides,
no rhetorical phrasing, and shorter wherever nothing was lost
- the technical reasons kept as they were, Qt quirks, wine and Proton behaviour
and ordering constraints being what the comments are for
- comment text only: the sources compare byte for byte once comments and blank
lines are stripped, and the build still compiles
Reword every comment in the repository in plain technical prose
<sub>2026-10-25-0929-every-comment-reworded-in-plain-technical-prose.md — 2026-10-25 09:29</sub>
The comments are written in an ornate, personifying style: anthropomorphic
subjects ("the corner the desktop says things in", "whatever the desktop is
wearing"), em-dash asides, rhetorical constructions ("cascading them all is
what nobody wants"), and indirection where a direct statement would do. The
information in them is usually worth keeping; the delivery is not.
Rules
- State what the code does, or why it does it that way, directly.
- No personification of widgets, files, screens or the desktop.
- No em-dash asides, no rhetorical pairs, no literary cadence.
- Keep the technical reason when there is one (Qt quirks, Wine behaviour,
ordering constraints); drop restatements of the code.
- One or two lines where the original took five, when nothing is lost.
- Comment text only. No code, signature, or behaviour changes.
Steps
- [x] 1. src/MainWindow.cpp, src/MainWindow.h
- [x] 2. src/LaunchersDialog.{cpp,h}, src/Launchers.{cpp,h}
- [x] 3. src/ItemPropertiesDialog.{cpp,h}, src/ItemDetails.{cpp,h},
src/ProgramItem.h, src/ItemKind.{cpp,h}, src/ItemLauncher.{cpp,h}
src/IconEffect.{cpp,h}, src/PeIconExtractor.{cpp,h}
src/GroupWindow.{cpp,h}, src/GroupCaptionStyle.{cpp,h},
src/MinimizedGroupIcon.{cpp,h}
src/AlignmentGuides.{cpp,h}, src/ScreenManager.{cpp,h}
- [x] 7. src/Theme.{cpp,h}, src/ThemeDialog.{cpp,h},
src/DesktopColorScheme.{cpp,h}, src/GnomeWallpaper.{cpp,h},
src/DesktopArea.{cpp,h}, src/DesktopShell.{cpp,h}
src/SteamLibrary.{cpp,h}, src/SteamGamePickerDialog.{cpp,h},
src/ApplicationPickerDialog.{cpp,h}, src/DesktopEntry.{cpp,h}
src/CalculatorPane.{cpp,h}, src/NotificationArea.{cpp,h},
src/LaunchNotices.{cpp,h}, src/SystemVolume.{cpp,h}
src/SearchProvider.{cpp,h}, src/Autostart.{cpp,h},
src/Kiosk.{cpp,h}, src/Ids.{cpp,h}, src/Version.h,
src/main.cpp
- [x] 11. tools/Screenshots.cpp
- [x] 12. CMakeLists.txt, cmake/*.cmake
- [x] 13. debian/postinst, debian/postrm, data/*, .vscode/*
- [x] 14. Build check (cmake --build build) and a read-back pass over the
diff for leftovers of the old style
<sub>Filed by prel from the completed plans at commit time.</sub>