https://bugs.kde.org/show_bug.cgi?id=394237
Bug ID: 394237
Summary: IDE-friendly URLs to documentation pages of checks
Product: clazy
Version: unspecified
Platform: Other
OS: Linux
Status: UNCONFIRMED
Severity: normal
Priority: NOR
Component: general
Assignee: unassigned-b...@kde.org
Reporter: nikolai.kos...@qt.io
CC: smart...@kde.org
Target Milestone: ---
Having some clazy check like "connect-by-name" it's not easily possible to link
to the documentation page of that check because the level is included in the
url.
Consider:
https://github.com/KDE/clazy/blob/master/src/checks/level0/README-connect-by-name.md
https://github.com/KDE/clazy/blob/master/src/checks/level1/README-connect-3arg-lambda.md
The first one has "level0" and the second one "level1" in the URL. Having only
the check name, we do not know the level and thus can't provide a link to such
a page.
Suggestion: Make the documentation pages accessible without any level in the
URL, ideally with some version:
<clazy base url>/docs/<version>/checks/<check-name>.md
Having that, we could easily link from e.g. Qt Creator to a documentation page
of a check.
--
You are receiving this mail because:
You are watching all bug changes.
