Fix format, rendering, typos, syntax, content in manuals.#8459
Fix format, rendering, typos, syntax, content in manuals.#8459vkucera wants to merge 1 commit intodanmar:mainfrom
Conversation
- 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." - "...." -> "..."
|
| @@ -1,22 +1,23 @@ | |||
| --- | |||
| title: Cppcheck Premium manual | |||
| subtitle: Version 2.21 dev | |||
There was a problem hiding this comment.
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..
There was a problem hiding this comment.
OK. What about the non-premium version?
There was a problem hiding this comment.
In manual.md it is proper to write such subtitle.
| ## Supported addons | ||
|
|
||
| ### namingng.py | ||
| ### `misra.py` |
There was a problem hiding this comment.
It's by intention that we don't document misra.py in Cppcheck Premium. Please remove this.
I don't know if there could be a better way to generate the manual-premium.md file instead. Take manual.md, modify the title, remove misra.py , add the premium chapter. using a script or some markdown functionality.
| @@ -1,22 +1,23 @@ | |||
| --- | |||
| title: Cppcheck Premium manual | |||
| subtitle: Version 2.21 dev | |||
There was a problem hiding this comment.
In manual.md it is proper to write such subtitle.
2 participants
Uh oh!
There was an error while loading. Please reload this page.