Skip to content

Fix format, rendering, typos, syntax, content in manuals.#8459

Open
vkucera wants to merge 1 commit intodanmar:mainfrom
vkucera:manual
Open

Fix format, rendering, typos, syntax, content in manuals.#8459
vkucera wants to merge 1 commit intodanmar:mainfrom
vkucera:manual

Conversation

@vkucera
Copy link
Copy Markdown

@vkucera vkucera commented Apr 16, 2026

  • Fix Markdown syntax.
  • Fix code rendering.
  • Sync content between manual and manual-premium. (Attempted to take the more recent pieces from each.)
    • I assume the premium version is supposed to be a trivial extension of the normal version, which should probably be automated by simply appending the extra section and changing the title.
  • Fix capitalisation of headings.
  • Fix capitalisation of abbreviations: XML, HTML, JSON, GCC.
  • Fix capitalisation of Cppcheck in prose.
  • Remove trailing spaces.
  • Fix missing commas after "If", "To".
  • Other English syntax fixes.
  • "etc" -> "etc."
  • "...." -> "..."

- Fix Markdown syntax.
- Fix code rendering.
- Sync content between manual and manual-premium. (Attempted to take the more recent pieces from each.)
- Fix capitalisation of headings.
- Fix capitalisation of abbreviations: XML, HTML, JSON, GCC.
- Fix capitalisation of Cppcheck in prose.
- Remove trailing spaces.
- Fix missing commas after "If", "To".
- Other English syntax fixes.
- "etc" -> "etc."
- "...." -> "..."
@sonarqubecloud
Copy link
Copy Markdown

@vkucera vkucera marked this pull request as ready for review April 16, 2026 22:11
Comment thread man/manual-premium.md
@@ -1,22 +1,23 @@
---
title: Cppcheck Premium manual
subtitle: Version 2.21 dev
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm this version is not correct. next premium version will be 26.x.0 . I don't know what "x" will be. I don't feel that we want to mantain this manually and skipping the subtitle seems easier..

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK. What about the non-premium version?

@lekanmatto-ship-it
Copy link
Copy Markdown

  • Fix Markdown syntax.

  • Fix code rendering.

  • Sync content between manual and manual-premium. (Attempted to take the more recent pieces from each.)

    • I assume the premium version is supposed to be a trivial extension of the normal version, which should probably be automated by simply appending the extra section and changing the title.
  • Fix capitalisation of headings.

  • Fix capitalisation of abbreviations: XML, HTML, JSON, GCC.

  • Fix capitalisation of Cppcheck in prose.

  • Remove trailing spaces.

  • Fix missing commas after "If", "To".

  • Other English syntax fixes.

  • "etc" -> "etc."

  • "...." -> "..."

Hello

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.

3 participants