Giters

cnescatlab / cnes-pylint-extension

cnes-pylint-extension is a python checker, which adds CNES specific checks to pylint.

Home Page:https://pypi.org/project/cnes-pylint-extension/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Improve information to be able to resolve issues

hbrtcnes opened this issue · comments

commented

Is your feature request related to a problem? Please describe.

When there is an issue in SonarQube, no details are available (here for rule PYLINT:W9095) when clicking "Why is it an issue?" :
image

Describe the solution you'd like

It would be nice to have details for all the rules (why is it an issue) and an example describing what is expected.

  • For example, for the rule PYLINT:W9095, we don't have enough details to find the expected format:
    image
    It would be nice to have an example with the expected format, when clicking "Why is it an issue?".

  • For example, for the rule PYLINT:R5403,
    image
    It would be nice to know why it is better to use argparse module, in what context (not when just passing arguments maybe).

  • For example, for the rule PYLINT:R5401,
    image
    It would be nice to know why consider dropping sys.exit() and how to replace it.

Versions

  • cnes-pylint-extension: 6.0.0
  • sonarQube: Community Edition Version 8.9.6 (build 50800)